files.com 1.1.727 → 1.1.729

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: b420386b41a1c244b703db88adc99b13ee43edb1e5dbed6ece36831ee550e620
4
- data.tar.gz: c20b1e21ac20e197d82a11273eb629dae3982fe52a97113ce5a8e6a543e8216f
3
+ metadata.gz: 2b18f71150e4b108a7f9cc83b7d08e3123b2edf875a0dc952c33840215460a39
4
+ data.tar.gz: 708e2f0575459db6d6f769335adfb52dc87fcb46660c6d7a03ef343942a078d3
5
5
  SHA512:
6
- metadata.gz: 89b1afce009f2e2f61d78c10b7384466366a460a7a78c7638dcdd5247c0e0eb2198ecb36af05237cbdc8bbdb6be68edb8d3b2cb0d1e745b8bf2b9c5f2cebe8b5
7
- data.tar.gz: 30455587f01661b418c4b09dddcb77f621cb7fd2f8cfe450e7506347f1d534286890c8adf5560be2689d9a0d531558504e3e1cfdd5a3128e086b9b303239f800
6
+ metadata.gz: e4153996df08529611c7ee9a176c2221977973e8271222058c03e624f40d716da64706751056f44b8644a5bf942298624c58193604d077ab5a8c1a59505bc314
7
+ data.tar.gz: 5a41b06f111f796adac8e17b805a5308b7ea7fdfdefb4a1bb01d327b9f7c234581f2781fded1fe5bd079e52965a52b4f93b8517699b9de80ffc30c1c0645e6bd
data/README.md CHANGED
@@ -545,7 +545,6 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
545
545
  |`ApiKeySessionsNotSupportedError`| `NotAuthenticatedError` |
546
546
  |`AuthenticationRequiredError`| `NotAuthenticatedError` |
547
547
  |`BundleRegistrationCodeFailedError`| `NotAuthenticatedError` |
548
- |`FilesAgentTokenFailedError`| `NotAuthenticatedError` |
549
548
  |`InboxRegistrationCodeFailedError`| `NotAuthenticatedError` |
550
549
  |`InvalidCredentialsError`| `NotAuthenticatedError` |
551
550
  |`InvalidOauthError`| `NotAuthenticatedError` |
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.727
1
+ 1.1.729
data/docs/as2_partner.md CHANGED
@@ -12,7 +12,7 @@
12
12
  "server_certificate": "require_match",
13
13
  "http_auth_username": "username",
14
14
  "additional_http_headers": {
15
- "key": "example value"
15
+ "X-Partner": "acme"
16
16
  },
17
17
  "default_mime_type": "application/octet-stream",
18
18
  "mdn_validation_level": "none",
@@ -93,7 +93,7 @@ Files::As2Partner.create(
93
93
  signature_validation_level: "normal",
94
94
  server_certificate: "require_match",
95
95
  default_mime_type: "application/octet-stream",
96
- additional_http_headers: {"key":"example value"},
96
+ additional_http_headers: {"X-Partner":"acme"},
97
97
  as2_station_id: 1,
98
98
  name: "AS2 Partner Name",
99
99
  uri: "example",
@@ -129,7 +129,7 @@ Files::As2Partner.update(id,
129
129
  signature_validation_level: "normal",
130
130
  server_certificate: "require_match",
131
131
  default_mime_type: "application/octet-stream",
132
- additional_http_headers: {"key":"example value"},
132
+ additional_http_headers: {"X-Partner":"acme"},
133
133
  name: "AS2 Partner Name",
134
134
  uri: "example",
135
135
  public_certificate: "example"
@@ -179,7 +179,7 @@ as2_partner.update(
179
179
  signature_validation_level: "normal",
180
180
  server_certificate: "require_match",
181
181
  default_mime_type: "application/octet-stream",
182
- additional_http_headers: {"key":"example value"},
182
+ additional_http_headers: {"X-Partner":"acme"},
183
183
  name: "AS2 Partner Name",
184
184
  uri: "example",
185
185
  public_certificate: "example"
data/docs/bundle.md CHANGED
@@ -77,14 +77,18 @@
77
77
  "uri": "https://mysite.files.com/.../my_image.png"
78
78
  },
79
79
  "watermark_value": {
80
- "key": "example value"
80
+ "gravity": "SouthWest",
81
+ "max_height_or_width": 20,
82
+ "transparency": 25
81
83
  },
82
84
  "send_one_time_password_to_recipient_at_registration": true,
83
85
  "workspace_id": 1,
84
86
  "has_inbox": true,
85
87
  "dont_allow_folders_in_uploads": true,
86
88
  "requested_upload_slots": [
87
- "example"
89
+ {
90
+ "name": "Photo ID"
91
+ }
88
92
  ],
89
93
  "paths": [
90
94
  "file.txt"
@@ -231,7 +235,8 @@ Files::Bundle.create(
231
235
  skip_company: true,
232
236
  start_access_on_date: "2000-01-01T01:00:00Z",
233
237
  snapshot_id: 1,
234
- workspace_id: 1
238
+ workspace_id: 1,
239
+ watermark_value: {"gravity":"SouthWest","max_height_or_width":20,"transparency":25}
235
240
  )
236
241
  ```
237
242
 
@@ -268,6 +273,7 @@ Files::Bundle.create(
268
273
  * `snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
269
274
  * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
270
275
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
276
+ * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
271
277
 
272
278
 
273
279
  ---
@@ -325,6 +331,7 @@ Files::Bundle.update(id,
325
331
  skip_name: true,
326
332
  user_id: 1,
327
333
  watermark_attachment_delete: false,
334
+ watermark_value: {"gravity":"SouthWest","max_height_or_width":20,"transparency":25},
328
335
  workspace_id: 1
329
336
  )
330
337
  ```
@@ -362,6 +369,7 @@ Files::Bundle.update(id,
362
369
  * `user_id` (int64): The owning user id. Only site admins can set this.
363
370
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
364
371
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
372
+ * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
365
373
  * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
366
374
 
367
375
 
@@ -437,6 +445,7 @@ bundle.update(
437
445
  skip_name: true,
438
446
  user_id: 1,
439
447
  watermark_attachment_delete: false,
448
+ watermark_value: {"gravity":"SouthWest","max_height_or_width":20,"transparency":25},
440
449
  workspace_id: 1
441
450
  )
442
451
  ```
@@ -474,6 +483,7 @@ bundle.update(
474
483
  * `user_id` (int64): The owning user id. Only site admins can set this.
475
484
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
476
485
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
486
+ * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
477
487
  * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
478
488
 
479
489
 
@@ -10,7 +10,7 @@
10
10
  "use_for_all_users": false,
11
11
  "disable_drive_mounting": false,
12
12
  "mount_mappings": {
13
- "key": "example value"
13
+ "W": "Americas"
14
14
  }
15
15
  }
16
16
  ```
@@ -59,7 +59,7 @@ Files::DesktopConfigurationProfile.find(id)
59
59
  ```
60
60
  Files::DesktopConfigurationProfile.create(
61
61
  name: "North America Desktop Profile",
62
- mount_mappings: {"key":"example value"},
62
+ mount_mappings: {"W":"Americas"},
63
63
  workspace_id: 1,
64
64
  use_for_all_users: false,
65
65
  disable_drive_mounting: false
@@ -83,7 +83,7 @@ Files::DesktopConfigurationProfile.create(
83
83
  Files::DesktopConfigurationProfile.update(id,
84
84
  name: "North America Desktop Profile",
85
85
  workspace_id: 1,
86
- mount_mappings: {"key":"example value"},
86
+ mount_mappings: {"W":"Americas"},
87
87
  use_for_all_users: false,
88
88
  disable_drive_mounting: false
89
89
  )
@@ -122,7 +122,7 @@ desktop_configuration_profile = Files::DesktopConfigurationProfile.find(id)
122
122
  desktop_configuration_profile.update(
123
123
  name: "North America Desktop Profile",
124
124
  workspace_id: 1,
125
- mount_mappings: {"key":"example value"},
125
+ mount_mappings: {"W":"Americas"},
126
126
  use_for_all_users: false,
127
127
  disable_drive_mounting: false
128
128
  )
data/docs/file.md CHANGED
@@ -17,7 +17,7 @@ may places where a Ruby File object can be used.
17
17
  "created_by_remote_server_id": 1,
18
18
  "created_by_sync_id": 1,
19
19
  "custom_metadata": {
20
- "key": "value"
20
+ "department": "finance"
21
21
  },
22
22
  "display_name": "file.txt",
23
23
  "type": "file",
@@ -140,7 +140,7 @@ Files::File.download(path,
140
140
 
141
141
  ```
142
142
  Files::File.create(path,
143
- custom_metadata: {"key":"value"},
143
+ custom_metadata: {"department":"finance"},
144
144
  length: 1,
145
145
  mkdir_parents: false,
146
146
  part: 1,
@@ -183,7 +183,7 @@ Files::File.create(path,
183
183
 
184
184
  ```
185
185
  Files::File.update(path,
186
- custom_metadata: {"key":"value"},
186
+ custom_metadata: {"department":"finance"},
187
187
  provided_mtime: "2000-01-01T01:00:00Z",
188
188
  priority_color: "red"
189
189
  )
@@ -464,7 +464,7 @@ file.download(
464
464
  file = Files::File.find(path)
465
465
 
466
466
  file.update(
467
- custom_metadata: {"key":"value"},
467
+ custom_metadata: {"department":"finance"},
468
468
  provided_mtime: "2000-01-01T01:00:00Z",
469
469
  priority_color: "red"
470
470
  )
data/docs/folder.md CHANGED
@@ -19,7 +19,7 @@ Files::Dir is an alias of Files::Folder
19
19
  "created_by_remote_server_id": 1,
20
20
  "created_by_sync_id": 1,
21
21
  "custom_metadata": {
22
- "key": "value"
22
+ "department": "finance"
23
23
  },
24
24
  "display_name": "file.txt",
25
25
  "type": "file",
@@ -9,7 +9,10 @@
9
9
  "workspace_id": 1,
10
10
  "use_for_all_users": false,
11
11
  "expected_remote_servers": [
12
- "example"
12
+ {
13
+ "server_type": "dropbox",
14
+ "name": "Dropbox"
15
+ }
13
16
  ]
14
17
  }
15
18
  ```
@@ -57,7 +60,7 @@ Files::IntegrationCentricProfile.find(id)
57
60
  ```
58
61
  Files::IntegrationCentricProfile.create(
59
62
  name: "Business Systems Onboarding",
60
- expected_remote_servers: ["example"],
63
+ expected_remote_servers: [{"server_type":"dropbox","name":"Dropbox"}],
61
64
  workspace_id: 1,
62
65
  use_for_all_users: false
63
66
  )
@@ -79,7 +82,7 @@ Files::IntegrationCentricProfile.create(
79
82
  Files::IntegrationCentricProfile.update(id,
80
83
  name: "Business Systems Onboarding",
81
84
  workspace_id: 1,
82
- expected_remote_servers: ["example"],
85
+ expected_remote_servers: [{"server_type":"dropbox","name":"Dropbox"}],
83
86
  use_for_all_users: false
84
87
  )
85
88
  ```
@@ -116,7 +119,7 @@ integration_centric_profile = Files::IntegrationCentricProfile.find(id)
116
119
  integration_centric_profile.update(
117
120
  name: "Business Systems Onboarding",
118
121
  workspace_id: 1,
119
- expected_remote_servers: ["example"],
122
+ expected_remote_servers: [{"server_type":"dropbox","name":"Dropbox"}],
120
123
  use_for_all_users: false
121
124
  )
122
125
  ```
@@ -64,7 +64,6 @@
64
64
  "enable_dedicated_ips": true,
65
65
  "files_agent_permission_set": "read_write",
66
66
  "files_agent_root": "example",
67
- "files_agent_api_token": "example",
68
67
  "files_agent_version": "example",
69
68
  "files_agent_up_to_date": true,
70
69
  "files_agent_latest_version": "example",
@@ -86,7 +85,7 @@
86
85
  ```
87
86
 
88
87
  * `id` (int64): Remote Server ID
89
- * `disabled` (boolean): If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
88
+ * `disabled` (boolean): If true, this Remote Server is disabled. Updating it clears this flag, except for retired Agent v1 records, which remain disabled.
90
89
  * `authentication_method` (string): Type of authentication method to use
91
90
  * `hostname` (string): Hostname or IP address
92
91
  * `remote_home_path` (string): Initial home folder on remote server
@@ -145,7 +144,6 @@
145
144
  * `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
146
145
  * `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
147
146
  * `files_agent_root` (string): Agent local root path
148
- * `files_agent_api_token` (string): Files Agent API Token
149
147
  * `files_agent_version` (string): Files Agent version
150
148
  * `files_agent_up_to_date` (boolean): If true, the Files Agent is up to date.
151
149
  * `files_agent_latest_version` (string): Latest available Files Agent version
@@ -420,42 +418,6 @@ Files::RemoteServer.agent_push_update(id)
420
418
  * `id` (int64): Required - Remote Server ID.
421
419
 
422
420
 
423
- ---
424
-
425
- ## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
426
-
427
- ```
428
- Files::RemoteServer.configuration_file(id,
429
- api_token: "example",
430
- permission_set: "example",
431
- root: "C:\\Users\\",
432
- hostname: "example",
433
- port: 1,
434
- status: "example",
435
- config_version: "example",
436
- private_key: "example",
437
- public_key: "example",
438
- server_host_key: "example",
439
- subdomain: "example"
440
- )
441
- ```
442
-
443
- ### Parameters
444
-
445
- * `id` (int64): Required - Remote Server ID.
446
- * `api_token` (string): Files Agent API Token
447
- * `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
448
- * `root` (string): The root directory for the agent
449
- * `hostname` (string):
450
- * `port` (int64): Incoming port for files agent connections
451
- * `status` (string): either running or shutdown
452
- * `config_version` (string): agent config version
453
- * `private_key` (string): The private key for the agent
454
- * `public_key` (string): public key
455
- * `server_host_key` (string):
456
- * `subdomain` (string): Files.com subdomain site name
457
-
458
-
459
421
  ---
460
422
 
461
423
  ## Update Remote Server
@@ -656,44 +618,6 @@ remote_server.agent_push_update
656
618
  * `id` (int64): Required - Remote Server ID.
657
619
 
658
620
 
659
- ---
660
-
661
- ## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
662
-
663
- ```
664
- remote_server = Files::RemoteServer.find(id)
665
-
666
- remote_server.configuration_file(
667
- api_token: "example",
668
- permission_set: "example",
669
- root: "C:\\Users\\",
670
- hostname: "example",
671
- port: 1,
672
- status: "example",
673
- config_version: "example",
674
- private_key: "example",
675
- public_key: "example",
676
- server_host_key: "example",
677
- subdomain: "example"
678
- )
679
- ```
680
-
681
- ### Parameters
682
-
683
- * `id` (int64): Required - Remote Server ID.
684
- * `api_token` (string): Files Agent API Token
685
- * `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
686
- * `root` (string): The root directory for the agent
687
- * `hostname` (string):
688
- * `port` (int64): Incoming port for files agent connections
689
- * `status` (string): either running or shutdown
690
- * `config_version` (string): agent config version
691
- * `private_key` (string): The private key for the agent
692
- * `public_key` (string): public key
693
- * `server_host_key` (string):
694
- * `subdomain` (string): Files.com subdomain site name
695
-
696
-
697
621
  ---
698
622
 
699
623
  ## Update Remote Server
@@ -22,14 +22,7 @@
22
22
  "override_max_concurrent_jobs": 1,
23
23
  "graceful_shutdown_timeout": 1,
24
24
  "transfer_rate_limit": "example",
25
- "auto_update_policy": "example",
26
- "api_token": "example",
27
- "port": 1,
28
- "hostname": "example",
29
- "public_key": "example",
30
- "status": "example",
31
- "server_host_key": "example",
32
- "config_version": "example"
25
+ "auto_update_policy": "example"
33
26
  }
34
27
  ```
35
28
 
@@ -62,10 +55,3 @@ Examples:
62
55
  * 1000 requests/hour: '1000-H'
63
56
  * 2000 requests/day: '2000-D'
64
57
  * `auto_update_policy` (string): Auto update policy ['manual_trigger', 'critical_only', 'always', 'never'] (default always)
65
- * `api_token` (string): Files Agent API Token
66
- * `port` (int64): Incoming port for files agent connections
67
- * `hostname` (string):
68
- * `public_key` (string): public key
69
- * `status` (string): either running or shutdown
70
- * `server_host_key` (string):
71
- * `config_version` (string): agent config version
data/docs/secret.md CHANGED
@@ -10,7 +10,7 @@
10
10
  "description": "Used by production API integrations.",
11
11
  "secret_type": "token",
12
12
  "metadata": {
13
- "key": "example value"
13
+ "header_name": "Authorization"
14
14
  },
15
15
  "value_field_names": [
16
16
  "example"
@@ -70,7 +70,7 @@ Files::Secret.create(
70
70
  name: "Production API token",
71
71
  description: "Used by production API integrations.",
72
72
  secret_type: "token",
73
- metadata: {"key":"example value"},
73
+ metadata: {"header_name":"Authorization"},
74
74
  workspace_id: 0
75
75
  )
76
76
  ```
@@ -93,7 +93,7 @@ Files::Secret.update(id,
93
93
  name: "Production API token",
94
94
  description: "Used by production API integrations.",
95
95
  secret_type: "token",
96
- metadata: {"key":"example value"}
96
+ metadata: {"header_name":"Authorization"}
97
97
  )
98
98
  ```
99
99
 
@@ -130,7 +130,7 @@ secret.update(
130
130
  name: "Production API token",
131
131
  description: "Used by production API integrations.",
132
132
  secret_type: "token",
133
- metadata: {"key":"example value"}
133
+ metadata: {"header_name":"Authorization"}
134
134
  )
135
135
  ```
136
136
 
@@ -12,7 +12,7 @@
12
12
  "file_format": "example",
13
13
  "file_interval_minutes": 1,
14
14
  "additional_headers": {
15
- "key": "example value"
15
+ "Authorization": "Bearer YOUR_TOKEN"
16
16
  },
17
17
  "sending_active": true,
18
18
  "generic_payload_type": "example",
@@ -162,7 +162,7 @@ Files::SiemHttpDestination.find(id)
162
162
  ```
163
163
  Files::SiemHttpDestination.create(
164
164
  name: "example",
165
- additional_headers: {"key":"example value"},
165
+ additional_headers: {"Authorization":"Bearer YOUR_TOKEN"},
166
166
  sending_active: true,
167
167
  generic_payload_type: "example",
168
168
  file_destination_path: "example",
@@ -237,7 +237,7 @@ Files::SiemHttpDestination.send_test_entry(
237
237
  destination_type: "example",
238
238
  destination_url: "example",
239
239
  name: "example",
240
- additional_headers: {"key":"example value"},
240
+ additional_headers: {"Authorization":"Bearer YOUR_TOKEN"},
241
241
  sending_active: true,
242
242
  generic_payload_type: "example",
243
243
  file_destination_path: "example",
@@ -308,7 +308,7 @@ Files::SiemHttpDestination.send_test_entry(
308
308
  ```
309
309
  Files::SiemHttpDestination.update(id,
310
310
  name: "example",
311
- additional_headers: {"key":"example value"},
311
+ additional_headers: {"Authorization":"Bearer YOUR_TOKEN"},
312
312
  sending_active: true,
313
313
  generic_payload_type: "example",
314
314
  file_destination_path: "example",
@@ -396,7 +396,7 @@ siem_http_destination = Files::SiemHttpDestination.find(id)
396
396
 
397
397
  siem_http_destination.update(
398
398
  name: "example",
399
- additional_headers: {"key":"example value"},
399
+ additional_headers: {"Authorization":"Bearer YOUR_TOKEN"},
400
400
  sending_active: true,
401
401
  generic_payload_type: "example",
402
402
  file_destination_path: "example",
data/docs/site.md CHANGED
@@ -56,7 +56,9 @@
56
56
  "uri": "https://mysite.files.com/.../my_image.png"
57
57
  },
58
58
  "bundle_watermark_value": {
59
- "key": "example value"
59
+ "gravity": "SouthWest",
60
+ "max_height_or_width": 20,
61
+ "transparency": 25
60
62
  },
61
63
  "calculate_file_checksums_crc32": true,
62
64
  "calculate_file_checksums_md5": true,
@@ -699,7 +701,6 @@ Files::Site.update(
699
701
  active_sftp_host_key_ids: [1],
700
702
  protocol_access_groups_only: false,
701
703
  revoke_bundle_access_on_disable_or_delete: false,
702
- bundle_watermark_value: {"key":"example value"},
703
704
  group_admins_can_add_users: false,
704
705
  group_admins_can_manage_group_memberships: false,
705
706
  group_admins_can_delete_users: false,
@@ -755,6 +756,7 @@ Files::Site.update(
755
756
  ldap_group_inclusion: "example",
756
757
  ldap_base_dn: "example",
757
758
  uploads_via_email_authentication: false,
759
+ bundle_watermark_value: {"gravity":"SouthWest","max_height_or_width":20,"transparency":25},
758
760
  icon16_delete: false,
759
761
  icon32_delete: false,
760
762
  icon48_delete: false,
@@ -883,7 +885,6 @@ Files::Site.update(
883
885
  * `active_sftp_host_key_ids` (array(int64)): Ids of the selected custom SFTP Host Keys
884
886
  * `protocol_access_groups_only` (boolean): If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
885
887
  * `revoke_bundle_access_on_disable_or_delete` (boolean): Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
886
- * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
887
888
  * `group_admins_can_add_users` (boolean): Allow group admins to create users in their groups
888
889
  * `group_admins_can_manage_group_memberships` (boolean): Allow group admins to add or remove existing users in their groups
889
890
  * `group_admins_can_delete_users` (boolean): Allow group admins to delete users in their groups
@@ -939,6 +940,7 @@ Files::Site.update(
939
940
  * `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
940
941
  * `ldap_base_dn` (string): Base DN for looking up users in LDAP server
941
942
  * `uploads_via_email_authentication` (boolean): Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
943
+ * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
942
944
  * `icon16_file` (file):
943
945
  * `icon16_delete` (boolean): If true, will delete the file stored in icon16
944
946
  * `icon32_file` (file):
@@ -103,7 +103,6 @@ module Files
103
103
  class ApiKeySessionsNotSupportedError < NotAuthenticatedError; end
104
104
  class AuthenticationRequiredError < NotAuthenticatedError; end
105
105
  class BundleRegistrationCodeFailedError < NotAuthenticatedError; end
106
- class FilesAgentTokenFailedError < NotAuthenticatedError; end
107
106
  class InboxRegistrationCodeFailedError < NotAuthenticatedError; end
108
107
  class InvalidCredentialsError < NotAuthenticatedError; end
109
108
  class InvalidOauthError < NotAuthenticatedError; end
@@ -541,6 +541,7 @@ module Files
541
541
  # user_id - int64 - The owning user id. Only site admins can set this.
542
542
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
543
543
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
544
+ # watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
544
545
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
545
546
  def update(params = {})
546
547
  params ||= {}
@@ -678,6 +679,7 @@ module Files
678
679
  # snapshot_id - int64 - ID of the snapshot containing this bundle's contents.
679
680
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
680
681
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
682
+ # watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
681
683
  def self.create(params = {}, options = {})
682
684
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
683
685
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
@@ -698,6 +700,7 @@ module Files
698
700
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
699
701
  raise InvalidParameterError.new("Bad parameter: snapshot_id must be an Integer") if params[:snapshot_id] and !params[:snapshot_id].is_a?(Integer)
700
702
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
703
+ raise InvalidParameterError.new("Bad parameter: watermark_value must be an Hash") if params[:watermark_value] and !params[:watermark_value].is_a?(Hash)
701
704
  raise MissingParameterError.new("Parameter missing: paths") unless params[:paths]
702
705
 
703
706
  response, options = Api.send_request("/bundles", :post, params, options)
@@ -754,6 +757,7 @@ module Files
754
757
  # user_id - int64 - The owning user id. Only site admins can set this.
755
758
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
756
759
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
760
+ # watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
757
761
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
758
762
  def self.update(id, params = {}, options = {})
759
763
  params ||= {}
@@ -776,6 +780,7 @@ module Files
776
780
  raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
777
781
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
778
782
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
783
+ raise InvalidParameterError.new("Bad parameter: watermark_value must be an Hash") if params[:watermark_value] and !params[:watermark_value].is_a?(Hash)
779
784
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
780
785
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
781
786
 
@@ -18,7 +18,7 @@ module Files
18
18
  @attributes[:id] = value
19
19
  end
20
20
 
21
- # boolean - If true, this Remote Server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
21
+ # boolean - If true, this Remote Server is disabled. Updating it clears this flag, except for retired Agent v1 records, which remain disabled.
22
22
  def disabled
23
23
  @attributes[:disabled]
24
24
  end
@@ -549,15 +549,6 @@ module Files
549
549
  @attributes[:files_agent_root] = value
550
550
  end
551
551
 
552
- # string - Files Agent API Token
553
- def files_agent_api_token
554
- @attributes[:files_agent_api_token]
555
- end
556
-
557
- def files_agent_api_token=(value)
558
- @attributes[:files_agent_api_token] = value
559
- end
560
-
561
552
  # string - Files Agent version
562
553
  def files_agent_version
563
554
  @attributes[:files_agent_version]
@@ -940,41 +931,6 @@ module Files
940
931
  Api.send_request("/remote_servers/#{@attributes[:id]}/agent_push_update", :post, params, @options)
941
932
  end
942
933
 
943
- # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
944
- #
945
- # Parameters:
946
- # api_token - string - Files Agent API Token
947
- # permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
948
- # root - string - The root directory for the agent
949
- # hostname - string
950
- # port - int64 - Incoming port for files agent connections
951
- # status - string - either running or shutdown
952
- # config_version - string - agent config version
953
- # private_key - string - The private key for the agent
954
- # public_key - string - public key
955
- # server_host_key - string
956
- # subdomain - string - Files.com subdomain site name
957
- def configuration_file(params = {})
958
- params ||= {}
959
- params[:id] = @attributes[:id]
960
- raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
961
- raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
962
- raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
963
- raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
964
- raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
965
- raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
966
- raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
967
- raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
968
- raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
969
- raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
970
- raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
971
- raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
972
- raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
973
- raise MissingParameterError.new("Parameter missing: id") unless params[:id]
974
-
975
- Api.send_request("/remote_servers/#{@attributes[:id]}/configuration_file", :post, params, @options)
976
- end
977
-
978
934
  # Parameters:
979
935
  # password - string - Password, if needed.
980
936
  # private_key - string - Private key, if needed.
@@ -1411,41 +1367,6 @@ module Files
1411
1367
  AgentPushUpdate.new(response.data, options)
1412
1368
  end
1413
1369
 
1414
- # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
1415
- #
1416
- # Parameters:
1417
- # api_token - string - Files Agent API Token
1418
- # permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
1419
- # root - string - The root directory for the agent
1420
- # hostname - string
1421
- # port - int64 - Incoming port for files agent connections
1422
- # status - string - either running or shutdown
1423
- # config_version - string - agent config version
1424
- # private_key - string - The private key for the agent
1425
- # public_key - string - public key
1426
- # server_host_key - string
1427
- # subdomain - string - Files.com subdomain site name
1428
- def self.configuration_file(id, params = {}, options = {})
1429
- params ||= {}
1430
- params[:id] = id
1431
- raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
1432
- raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
1433
- raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
1434
- raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
1435
- raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
1436
- raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
1437
- raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
1438
- raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
1439
- raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
1440
- raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
1441
- raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
1442
- raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
1443
- raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1444
-
1445
- response, options = Api.send_request("/remote_servers/#{params[:id]}/configuration_file", :post, params, options)
1446
- RemoteServerConfigurationFile.new(response.data, options)
1447
- end
1448
-
1449
1370
  # Parameters:
1450
1371
  # password - string - Password, if needed.
1451
1372
  # private_key - string - Private key, if needed.
@@ -113,40 +113,5 @@ module Files
113
113
  def auto_update_policy
114
114
  @attributes[:auto_update_policy]
115
115
  end
116
-
117
- # string - Files Agent API Token
118
- def api_token
119
- @attributes[:api_token]
120
- end
121
-
122
- # int64 - Incoming port for files agent connections
123
- def port
124
- @attributes[:port]
125
- end
126
-
127
- # string
128
- def hostname
129
- @attributes[:hostname]
130
- end
131
-
132
- # string - public key
133
- def public_key
134
- @attributes[:public_key]
135
- end
136
-
137
- # string - either running or shutdown
138
- def status
139
- @attributes[:status]
140
- end
141
-
142
- # string
143
- def server_host_key
144
- @attributes[:server_host_key]
145
- end
146
-
147
- # string - agent config version
148
- def config_version
149
- @attributes[:config_version]
150
- end
151
116
  end
152
117
  end
@@ -1114,7 +1114,6 @@ module Files
1114
1114
  # active_sftp_host_key_ids - array(int64) - Ids of the selected custom SFTP Host Keys
1115
1115
  # protocol_access_groups_only - boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
1116
1116
  # revoke_bundle_access_on_disable_or_delete - boolean - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
1117
- # bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
1118
1117
  # group_admins_can_add_users - boolean - Allow group admins to create users in their groups
1119
1118
  # group_admins_can_manage_group_memberships - boolean - Allow group admins to add or remove existing users in their groups
1120
1119
  # group_admins_can_delete_users - boolean - Allow group admins to delete users in their groups
@@ -1170,6 +1169,7 @@ module Files
1170
1169
  # ldap_group_inclusion - string - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
1171
1170
  # ldap_base_dn - string - Base DN for looking up users in LDAP server
1172
1171
  # uploads_via_email_authentication - boolean - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
1172
+ # bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
1173
1173
  # icon16_file - file
1174
1174
  # icon16_delete - boolean - If true, will delete the file stored in icon16
1175
1175
  # icon32_file - file
@@ -1230,7 +1230,6 @@ module Files
1230
1230
  raise InvalidParameterError.new("Bad parameter: sftp_host_key_type must be an String") if params[:sftp_host_key_type] and !params[:sftp_host_key_type].is_a?(String)
1231
1231
  raise InvalidParameterError.new("Bad parameter: active_sftp_host_key_id must be an Integer") if params[:active_sftp_host_key_id] and !params[:active_sftp_host_key_id].is_a?(Integer)
1232
1232
  raise InvalidParameterError.new("Bad parameter: active_sftp_host_key_ids must be an Array") if params[:active_sftp_host_key_ids] and !params[:active_sftp_host_key_ids].is_a?(Array)
1233
- raise InvalidParameterError.new("Bad parameter: bundle_watermark_value must be an Hash") if params[:bundle_watermark_value] and !params[:bundle_watermark_value].is_a?(Hash)
1234
1233
  raise InvalidParameterError.new("Bad parameter: bundle_recipient_blacklist_domains must be an Array") if params[:bundle_recipient_blacklist_domains] and !params[:bundle_recipient_blacklist_domains].is_a?(Array)
1235
1234
  raise InvalidParameterError.new("Bad parameter: require_2fa_user_type must be an String") if params[:require_2fa_user_type] and !params[:require_2fa_user_type].is_a?(String)
1236
1235
  raise InvalidParameterError.new("Bad parameter: color2_top must be an String") if params[:color2_top] and !params[:color2_top].is_a?(String)
@@ -1263,6 +1262,7 @@ module Files
1263
1262
  raise InvalidParameterError.new("Bad parameter: ldap_group_exclusion must be an String") if params[:ldap_group_exclusion] and !params[:ldap_group_exclusion].is_a?(String)
1264
1263
  raise InvalidParameterError.new("Bad parameter: ldap_group_inclusion must be an String") if params[:ldap_group_inclusion] and !params[:ldap_group_inclusion].is_a?(String)
1265
1264
  raise InvalidParameterError.new("Bad parameter: ldap_base_dn must be an String") if params[:ldap_base_dn] and !params[:ldap_base_dn].is_a?(String)
1265
+ raise InvalidParameterError.new("Bad parameter: bundle_watermark_value must be an Hash") if params[:bundle_watermark_value] and !params[:bundle_watermark_value].is_a?(Hash)
1266
1266
  raise InvalidParameterError.new("Bad parameter: ldap_password_change must be an String") if params[:ldap_password_change] and !params[:ldap_password_change].is_a?(String)
1267
1267
  raise InvalidParameterError.new("Bad parameter: ldap_password_change_confirmation must be an String") if params[:ldap_password_change_confirmation] and !params[:ldap_password_change_confirmation].is_a?(String)
1268
1268
  raise InvalidParameterError.new("Bad parameter: smtp_password must be an String") if params[:smtp_password] and !params[:smtp_password].is_a?(String)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.727"
4
+ VERSION = "1.1.729"
5
5
  end
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.727
4
+ version: 1.1.729
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-16 00:00:00.000000000 Z
11
+ date: 2026-09-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable