files.com 1.1.283 → 1.1.285

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4f0f87feb1ff29fbb4bf594b654ac77b55bd3c3d771253d4a488a2fd8ebf3909
4
- data.tar.gz: 0c10e3aee4976a4beceaa2633afa2088411627f8c398eb25fee487c09e6deea1
3
+ metadata.gz: b352bf2901921caf5aede20cd4f2821c923ab0f0d2401e2e9d2c9ea7da24ae85
4
+ data.tar.gz: 5e5331ce0145b7aa801a2ccf811671d532867af1c5fb9681658f2ec98d8cc15f
5
5
  SHA512:
6
- metadata.gz: 120feb78a7f6d69a9a707aa592dd7f66e4d81e852b27114322c84b525732141ae37d23cc4f604d0bb1b8ee2a40cfd64e8f4ffaa0bbd5ea949f096fae1c48eabd
7
- data.tar.gz: fcc6ae3de360a972e6fc84b7c5509c4cf4a746621c6eaca33383e3f6197b64c8de61418108e199a3f9eaa46f31d0ee284115a8ea1e60887678aeb56122168cb1
6
+ metadata.gz: 1ef906531c60ef7829254a1f4c5c0c70ac9a4876af9f809d2fcb69d677e839db00dfd2c6ed245f2e6287bf48140cbd6b2388f1ef3e48931a1fd9dc01e721669a
7
+ data.tar.gz: 3cc141016bdd1ca0a17dc7f101db68f94415de1489265f38661c28e7f5d94452056940673710d0a5de2989b3ef4773072ecf7dc259124c5356ce4298fc73e06f
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.283
1
+ 1.1.285
data/docs/automation.md CHANGED
@@ -86,7 +86,8 @@
86
86
  "value": {
87
87
  "limit": "1"
88
88
  },
89
- "webhook_url": "https://app.files.com/api/webhooks/abc123"
89
+ "webhook_url": "https://app.files.com/api/webhooks/abc123",
90
+ "holiday_region": "us_dc"
90
91
  }
91
92
  ```
92
93
 
@@ -128,6 +129,7 @@
128
129
  * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
129
130
  * `value` (object): A Hash of attributes specific to the automation type.
130
131
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
132
+ * `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
131
133
 
132
134
 
133
135
  ---
@@ -0,0 +1,27 @@
1
+ # HolidayRegion
2
+
3
+ ## Example HolidayRegion Object
4
+
5
+ ```
6
+ {
7
+ "code": "us_dc",
8
+ "name": "United States - District of Columbia"
9
+ }
10
+ ```
11
+
12
+ * `code` (string): The code representing a region
13
+ * `name` (string): The name of the region
14
+
15
+
16
+ ---
17
+
18
+ ## List all possible holiday regions
19
+
20
+ ```
21
+ Files::HolidayRegion.get_supported
22
+ ```
23
+
24
+ ### Parameters
25
+
26
+ * `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.
27
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/site.md CHANGED
@@ -60,7 +60,6 @@
60
60
  "custom_namespace": true,
61
61
  "dav_enabled": true,
62
62
  "dav_user_root_enabled": true,
63
- "days_before_deleting_disabled_users": 30,
64
63
  "days_to_retain_backups": 30,
65
64
  "document_edits_in_bundle_allowed": true,
66
65
  "default_time_zone": "Pacific Time (US & Canada)",
@@ -352,7 +351,6 @@
352
351
  * `custom_namespace` (boolean): Is this site using a custom namespace for users?
353
352
  * `dav_enabled` (boolean): Is WebDAV enabled?
354
353
  * `dav_user_root_enabled` (boolean): Use user FTP roots also for WebDAV?
355
- * `days_before_deleting_disabled_users` (int64): Number of days to keep disabled users before deleting them. If set to 0, disabled users will not be deleted.
356
354
  * `days_to_retain_backups` (int64): Number of days to keep deleted files
357
355
  * `document_edits_in_bundle_allowed` (boolean): If true, allow public viewers of Bundles with full permissions to use document editing integrations.
358
356
  * `default_time_zone` (string): Site default time zone
@@ -558,7 +556,6 @@ Files::Site.update(
558
556
  allowed_countries: "US,DE",
559
557
  allowed_ips: "example",
560
558
  disallowed_countries: "US,DE",
561
- days_before_deleting_disabled_users: 1,
562
559
  days_to_retain_backups: 1,
563
560
  max_prior_passwords: 1,
564
561
  password_validity_days: 1,
@@ -718,7 +715,6 @@ Files::Site.update(
718
715
  * `allowed_countries` (string): Comma separated list of allowed Country codes
719
716
  * `allowed_ips` (string): List of allowed IP addresses
720
717
  * `disallowed_countries` (string): Comma separated list of disallowed Country codes
721
- * `days_before_deleting_disabled_users` (int64): Number of days to keep disabled users before deleting them. If set to 0, disabled users will not be deleted.
722
718
  * `days_to_retain_backups` (int64): Number of days to keep deleted files
723
719
  * `max_prior_passwords` (int64): Number of prior passwords to disallow
724
720
  * `password_validity_days` (int64): Number of days password is valid
data/docs/sync.md CHANGED
@@ -39,7 +39,8 @@
39
39
  "06:30",
40
40
  "14:30"
41
41
  ],
42
- "schedule_time_zone": "Eastern Time (US & Canada)"
42
+ "schedule_time_zone": "Eastern Time (US & Canada)",
43
+ "holiday_region": "us_dc"
43
44
  }
44
45
  ```
45
46
 
@@ -68,6 +69,7 @@
68
69
  * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
69
70
  * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
70
71
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
72
+ * `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
71
73
 
72
74
 
73
75
  ---
@@ -10,6 +10,7 @@
10
10
  "include_folder_admins": true,
11
11
  "include_site_admins": true,
12
12
  "action": "disable",
13
+ "user_state": "inactive",
13
14
  "site_id": 1
14
15
  }
15
16
  ```
@@ -20,6 +21,7 @@
20
21
  * `include_folder_admins` (boolean): Include folder admins in the rule
21
22
  * `include_site_admins` (boolean): Include site admins in the rule
22
23
  * `action` (string): Action to take on inactive users (disable or delete)
24
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
23
25
  * `site_id` (int64): Site ID
24
26
 
25
27
 
@@ -59,7 +61,8 @@ Files::UserLifecycleRule.create(
59
61
  authentication_method: "password",
60
62
  inactivity_days: 12,
61
63
  include_site_admins: true,
62
- include_folder_admins: true
64
+ include_folder_admins: true,
65
+ user_state: "inactive"
63
66
  )
64
67
  ```
65
68
 
@@ -70,6 +73,7 @@ Files::UserLifecycleRule.create(
70
73
  * `inactivity_days` (int64): Required - Number of days of inactivity before the rule applies
71
74
  * `include_site_admins` (boolean): Include site admins in the rule
72
75
  * `include_folder_admins` (boolean): Include folder admins in the rule
76
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
73
77
 
74
78
 
75
79
  ---
@@ -81,7 +85,8 @@ Files::UserLifecycleRule.update(id,
81
85
  authentication_method: "password",
82
86
  inactivity_days: 12,
83
87
  include_site_admins: true,
84
- include_folder_admins: true
88
+ include_folder_admins: true,
89
+ user_state: "inactive"
85
90
  )
86
91
  ```
87
92
 
@@ -93,6 +98,7 @@ Files::UserLifecycleRule.update(id,
93
98
  * `inactivity_days` (int64): Required - Number of days of inactivity before the rule applies
94
99
  * `include_site_admins` (boolean): Include site admins in the rule
95
100
  * `include_folder_admins` (boolean): Include folder admins in the rule
101
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
96
102
 
97
103
 
98
104
  ---
@@ -119,7 +125,8 @@ user_lifecycle_rule.update(
119
125
  authentication_method: "password",
120
126
  inactivity_days: 12,
121
127
  include_site_admins: true,
122
- include_folder_admins: true
128
+ include_folder_admins: true,
129
+ user_state: "inactive"
123
130
  )
124
131
  ```
125
132
 
@@ -131,6 +138,7 @@ user_lifecycle_rule.update(
131
138
  * `inactivity_days` (int64): Required - Number of days of inactivity before the rule applies
132
139
  * `include_site_admins` (boolean): Include site admins in the rule
133
140
  * `include_folder_admins` (boolean): Include folder admins in the rule
141
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
134
142
 
135
143
 
136
144
  ---
@@ -351,6 +351,15 @@ module Files
351
351
  @attributes[:webhook_url] = value
352
352
  end
353
353
 
354
+ # string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
355
+ def holiday_region
356
+ @attributes[:holiday_region]
357
+ end
358
+
359
+ def holiday_region=(value)
360
+ @attributes[:holiday_region] = value
361
+ end
362
+
354
363
  # Manually Run Automation
355
364
  def manual_run(params = {})
356
365
  params ||= {}
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class HolidayRegion
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # string - The code representing a region
13
+ def code
14
+ @attributes[:code]
15
+ end
16
+
17
+ # string - The name of the region
18
+ def name
19
+ @attributes[:name]
20
+ end
21
+
22
+ # Parameters:
23
+ # 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.
24
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
25
+ def self.get_supported(params = {}, options = {})
26
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
27
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
28
+
29
+ List.new(HolidayRegion, params) do
30
+ Api.send_request("/holiday_regions/supported", :get, params, options)
31
+ end
32
+ end
33
+ end
34
+ end
@@ -244,11 +244,6 @@ module Files
244
244
  @attributes[:dav_user_root_enabled]
245
245
  end
246
246
 
247
- # int64 - Number of days to keep disabled users before deleting them. If set to 0, disabled users will not be deleted.
248
- def days_before_deleting_disabled_users
249
- @attributes[:days_before_deleting_disabled_users]
250
- end
251
-
252
247
  # int64 - Number of days to keep deleted files
253
248
  def days_to_retain_backups
254
249
  @attributes[:days_to_retain_backups]
@@ -932,7 +927,6 @@ module Files
932
927
  # allowed_countries - string - Comma separated list of allowed Country codes
933
928
  # allowed_ips - string - List of allowed IP addresses
934
929
  # disallowed_countries - string - Comma separated list of disallowed Country codes
935
- # days_before_deleting_disabled_users - int64 - Number of days to keep disabled users before deleting them. If set to 0, disabled users will not be deleted.
936
930
  # days_to_retain_backups - int64 - Number of days to keep deleted files
937
931
  # max_prior_passwords - int64 - Number of prior passwords to disallow
938
932
  # password_validity_days - int64 - Number of days password is valid
@@ -1067,7 +1061,6 @@ module Files
1067
1061
  raise InvalidParameterError.new("Bad parameter: allowed_countries must be an String") if params[:allowed_countries] and !params[:allowed_countries].is_a?(String)
1068
1062
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
1069
1063
  raise InvalidParameterError.new("Bad parameter: disallowed_countries must be an String") if params[:disallowed_countries] and !params[:disallowed_countries].is_a?(String)
1070
- raise InvalidParameterError.new("Bad parameter: days_before_deleting_disabled_users must be an Integer") if params[:days_before_deleting_disabled_users] and !params[:days_before_deleting_disabled_users].is_a?(Integer)
1071
1064
  raise InvalidParameterError.new("Bad parameter: days_to_retain_backups must be an Integer") if params[:days_to_retain_backups] and !params[:days_to_retain_backups].is_a?(Integer)
1072
1065
  raise InvalidParameterError.new("Bad parameter: max_prior_passwords must be an Integer") if params[:max_prior_passwords] and !params[:max_prior_passwords].is_a?(Integer)
1073
1066
  raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
@@ -226,6 +226,15 @@ module Files
226
226
  @attributes[:schedule_time_zone] = value
227
227
  end
228
228
 
229
+ # string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
230
+ def holiday_region
231
+ @attributes[:holiday_region]
232
+ end
233
+
234
+ def holiday_region=(value)
235
+ @attributes[:holiday_region] = value
236
+ end
237
+
229
238
  # Manually Run Sync
230
239
  def manual_run(params = {})
231
240
  params ||= {}
@@ -63,6 +63,15 @@ module Files
63
63
  @attributes[:action] = value
64
64
  end
65
65
 
66
+ # string - State of the users to apply the rule to (inactive or disabled)
67
+ def user_state
68
+ @attributes[:user_state]
69
+ end
70
+
71
+ def user_state=(value)
72
+ @attributes[:user_state] = value
73
+ end
74
+
66
75
  # int64 - Site ID
67
76
  def site_id
68
77
  @attributes[:site_id]
@@ -78,6 +87,7 @@ module Files
78
87
  # inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
79
88
  # include_site_admins - boolean - Include site admins in the rule
80
89
  # include_folder_admins - boolean - Include folder admins in the rule
90
+ # user_state - string - State of the users to apply the rule to (inactive or disabled)
81
91
  def update(params = {})
82
92
  params ||= {}
83
93
  params[:id] = @attributes[:id]
@@ -86,6 +96,7 @@ module Files
86
96
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
87
97
  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
88
98
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
99
+ raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
89
100
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
90
101
  raise MissingParameterError.new("Parameter missing: action") unless params[:action]
91
102
  raise MissingParameterError.new("Parameter missing: authentication_method") unless params[:authentication_method]
@@ -158,10 +169,12 @@ module Files
158
169
  # inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
159
170
  # include_site_admins - boolean - Include site admins in the rule
160
171
  # include_folder_admins - boolean - Include folder admins in the rule
172
+ # user_state - string - State of the users to apply the rule to (inactive or disabled)
161
173
  def self.create(params = {}, options = {})
162
174
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
163
175
  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
164
176
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
177
+ raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
165
178
  raise MissingParameterError.new("Parameter missing: action") unless params[:action]
166
179
  raise MissingParameterError.new("Parameter missing: authentication_method") unless params[:authentication_method]
167
180
  raise MissingParameterError.new("Parameter missing: inactivity_days") unless params[:inactivity_days]
@@ -176,6 +189,7 @@ module Files
176
189
  # inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
177
190
  # include_site_admins - boolean - Include site admins in the rule
178
191
  # include_folder_admins - boolean - Include folder admins in the rule
192
+ # user_state - string - State of the users to apply the rule to (inactive or disabled)
179
193
  def self.update(id, params = {}, options = {})
180
194
  params ||= {}
181
195
  params[:id] = id
@@ -183,6 +197,7 @@ module Files
183
197
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
184
198
  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
185
199
  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
200
+ raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
186
201
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
187
202
  raise MissingParameterError.new("Parameter missing: action") unless params[:action]
188
203
  raise MissingParameterError.new("Parameter missing: authentication_method") unless params[:authentication_method]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.283"
4
+ VERSION = "1.1.285"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -80,6 +80,7 @@ require "files.com/models/group_user"
80
80
  require "files.com/models/history"
81
81
  require "files.com/models/history_export"
82
82
  require "files.com/models/history_export_result"
83
+ require "files.com/models/holiday_region"
83
84
  require "files.com/models/image"
84
85
  require "files.com/models/inbox_recipient"
85
86
  require "files.com/models/inbox_registration"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.283
4
+ version: 1.1.285
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-06-25 00:00:00.000000000 Z
11
+ date: 2025-06-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -163,6 +163,7 @@ files:
163
163
  - docs/history.md
164
164
  - docs/history_export.md
165
165
  - docs/history_export_result.md
166
+ - docs/holiday_region.md
166
167
  - docs/image.md
167
168
  - docs/inbox_recipient.md
168
169
  - docs/inbox_registration.md
@@ -273,6 +274,7 @@ files:
273
274
  - lib/files.com/models/history.rb
274
275
  - lib/files.com/models/history_export.rb
275
276
  - lib/files.com/models/history_export_result.rb
277
+ - lib/files.com/models/holiday_region.rb
276
278
  - lib/files.com/models/image.rb
277
279
  - lib/files.com/models/inbox_recipient.rb
278
280
  - lib/files.com/models/inbox_registration.rb