files.com 1.1.773 → 1.1.775

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: 07f3cc24cf0891a91c9feaf9fdeeae39301d8b23a32207616eba7db5cc070ace
4
- data.tar.gz: b1619f673e77c0a9423c8083ec425a6ea26f61cd9a1d6aa9629be3d6e0f70cf6
3
+ metadata.gz: d4c219d136b284a59d807f0457203b8c9cea7dfc0a2e816df7be244d5a063546
4
+ data.tar.gz: 92418b15c3786ca448d176d68a3e1d2a9a16e1a9c69a0c8713642e37c87b7f74
5
5
  SHA512:
6
- metadata.gz: 85ca525bf43d05c3cf61e12aaea2fc9c22a97f8b2c31a8e136e6840d7578e8e88bb703d49c850068286195f89bf5c943371dead5f15ab813cae0a700f661e1f5
7
- data.tar.gz: 4fad3a9f835494fc420493feac4aed82c9ad1d4a23a14674fffdcaece12c3d5ba5480b53a60a337851d5a1bfcc840cae3b4988eabe7c58c8123f131091bcf9fc
6
+ metadata.gz: aa90b8947359abecb1f93143a999a5816d291bba7d3087966baaaa695acc90f02a4c0d5b73ebbd7a34c93f831d815809995b6f977159ffeb74573169236adeb2
7
+ data.tar.gz: c160181dd3b0241c69b86a86d11afb2f2a73a83f3c17c8ac913aabea1d9c5307981c267f7f8dd01839924591cdeefde9f522127938d71df3217ba0b6df26c7b2
data/README.md CHANGED
@@ -67,7 +67,7 @@ the method used in the examples on this site.
67
67
 
68
68
  To use an API Key, first generate an API key from the [web
69
69
  interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
70
- SDK](/ruby/resources/developers/api-keys).
70
+ SDK](https://developers.files.com/ruby/resources/developers/api-keys).
71
71
 
72
72
  Note that when using a user-specific API key, if the user is an administrator, you will have full
73
73
  access to the entire API. If the user is not an administrator, you will only be able to access files
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.773
1
+ 1.1.775
data/docs/as2_partner.md CHANGED
@@ -39,7 +39,7 @@
39
39
  * `additional_http_headers` (object): Additional HTTP Headers for outgoing message sent to this partner.
40
40
  * `default_mime_type` (string): Default mime type of the file attached to the encrypted message
41
41
  * `mdn_validation_level` (string): How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
42
- * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
42
+ * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
43
43
  * `enable_dedicated_ips` (boolean): If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
44
44
  * `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
45
45
  * `public_certificate` (string): Public certificate used for message security.
@@ -109,7 +109,7 @@ Files::As2Partner.create(
109
109
  * `http_auth_username` (string): Username to send to server for HTTP Authentication.
110
110
  * `http_auth_password` (string): Password to send to server for HTTP Authentication.
111
111
  * `mdn_validation_level` (string): How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
112
- * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
112
+ * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
113
113
  * `server_certificate` (string): Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
114
114
  * `default_mime_type` (string): Default mime type of the file attached to the encrypted message
115
115
  * `additional_http_headers` (object): Additional HTTP Headers for outgoing message sent to this partner.
@@ -147,7 +147,7 @@ Files::As2Partner.update(id,
147
147
  * `http_auth_username` (string): Username to send to server for HTTP Authentication.
148
148
  * `http_auth_password` (string): Password to send to server for HTTP Authentication.
149
149
  * `mdn_validation_level` (string): How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
150
- * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
150
+ * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
151
151
  * `server_certificate` (string): Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
152
152
  * `default_mime_type` (string): Default mime type of the file attached to the encrypted message
153
153
  * `additional_http_headers` (object): Additional HTTP Headers for outgoing message sent to this partner.
@@ -199,7 +199,7 @@ as2_partner.update(
199
199
  * `http_auth_username` (string): Username to send to server for HTTP Authentication.
200
200
  * `http_auth_password` (string): Password to send to server for HTTP Authentication.
201
201
  * `mdn_validation_level` (string): How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
202
- * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
202
+ * `signature_validation_level` (string): Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
203
203
  * `server_certificate` (string): Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
204
204
  * `default_mime_type` (string): Default mime type of the file attached to the encrypted message
205
205
  * `additional_http_headers` (object): Additional HTTP Headers for outgoing message sent to this partner.
data/docs/file.md CHANGED
@@ -282,6 +282,22 @@ Files::File.zip_list_contents(path)
282
282
  * `path` (string): Required - Path to operate on.
283
283
 
284
284
 
285
+ ---
286
+
287
+ ## Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion
288
+
289
+ ```
290
+ Files::File.begin_delete(path,
291
+ recursive: false
292
+ )
293
+ ```
294
+
295
+ ### Parameters
296
+
297
+ * `path` (string): Required - Path to operate on.
298
+ * `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
299
+
300
+
285
301
  ---
286
302
 
287
303
  ## Copy File/Folder
@@ -548,6 +564,24 @@ file.zip_list_contents
548
564
  * `path` (string): Required - Path to operate on.
549
565
 
550
566
 
567
+ ---
568
+
569
+ ## Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion
570
+
571
+ ```
572
+ file = Files::File.find(path)
573
+
574
+ file.begin_delete(
575
+ recursive: false
576
+ )
577
+ ```
578
+
579
+ ### Parameters
580
+
581
+ * `path` (string): Required - Path to operate on.
582
+ * `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
583
+
584
+
551
585
  ---
552
586
 
553
587
  ## Copy File/Folder
data/docs/file_action.md CHANGED
@@ -10,4 +10,4 @@
10
10
  ```
11
11
 
12
12
  * `status` (string): Status of file operation.
13
- * `file_migration_id` (int64): If status is pending, this is the id of the File Migration to check for status updates.
13
+ * `file_migration_id` (int64): If status is pending, this is the id of the File Migration to check for status updates. Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.
@@ -99,7 +99,7 @@ module Files
99
99
  @attributes[:mdn_validation_level] = value
100
100
  end
101
101
 
102
- # string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
102
+ # string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
103
103
  def signature_validation_level
104
104
  @attributes[:signature_validation_level]
105
105
  end
@@ -221,7 +221,7 @@ module Files
221
221
  # http_auth_username - string - Username to send to server for HTTP Authentication.
222
222
  # http_auth_password - string - Password to send to server for HTTP Authentication.
223
223
  # mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
224
- # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
224
+ # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
225
225
  # server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
226
226
  # default_mime_type - string - Default mime type of the file attached to the encrypted message
227
227
  # additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -332,7 +332,7 @@ module Files
332
332
  # http_auth_username - string - Username to send to server for HTTP Authentication.
333
333
  # http_auth_password - string - Password to send to server for HTTP Authentication.
334
334
  # mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
335
- # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
335
+ # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
336
336
  # server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
337
337
  # default_mime_type - string - Default mime type of the file attached to the encrypted message
338
338
  # additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -374,7 +374,7 @@ module Files
374
374
  # http_auth_username - string - Username to send to server for HTTP Authentication.
375
375
  # http_auth_password - string - Password to send to server for HTTP Authentication.
376
376
  # mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
377
- # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
377
+ # signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages? `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
378
378
  # server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
379
379
  # default_mime_type - string - Default mime type of the file attached to the encrypted message
380
380
  # additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -1145,6 +1145,20 @@ module Files
1145
1145
  Api.send_request("/file_actions/zip_list/#{@attributes[:path]}", :get, params, @options)
1146
1146
  end
1147
1147
 
1148
+ # Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion
1149
+ #
1150
+ # Parameters:
1151
+ # recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
1152
+ def begin_delete(params = {})
1153
+ params ||= {}
1154
+ params[:path] = @attributes[:path]
1155
+ raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
1156
+ raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
1157
+ raise MissingParameterError.new("Parameter missing: path") unless params[:path]
1158
+
1159
+ Api.send_request("/file_actions/delete/#{@attributes[:path]}", :post, params, @options)
1160
+ end
1161
+
1148
1162
  # Copy File/Folder
1149
1163
  #
1150
1164
  # Parameters:
@@ -1466,6 +1480,25 @@ module Files
1466
1480
  end
1467
1481
  end
1468
1482
 
1483
+ # Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion
1484
+ #
1485
+ # Parameters:
1486
+ # recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
1487
+ #
1488
+ # params:: Hash of API operation parameter values.
1489
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1490
+ #
1491
+ # Returns a Files::FileAction.
1492
+ def self.begin_delete(path, params = {}, options = {})
1493
+ params ||= {}
1494
+ params[:path] = path
1495
+ raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
1496
+ raise MissingParameterError.new("Parameter missing: path") unless params[:path]
1497
+
1498
+ response, options = Api.send_request("/file_actions/delete/#{params[:path]}", :post, params, options) { |reply| reply.require_object("FileAction") }
1499
+ FileAction.new(response.data, options)
1500
+ end
1501
+
1469
1502
  # Copy File/Folder
1470
1503
  #
1471
1504
  # Parameters:
@@ -14,7 +14,7 @@ module Files
14
14
  @attributes[:status]
15
15
  end
16
16
 
17
- # int64 - If status is pending, this is the id of the File Migration to check for status updates.
17
+ # int64 - If status is pending, this is the id of the File Migration to check for status updates. Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.
18
18
  def file_migration_id
19
19
  @attributes[:file_migration_id]
20
20
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.773"
4
+ VERSION = "1.1.775"
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.773
4
+ version: 1.1.775
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-10-09 00:00:00.000000000 Z
11
+ date: 2026-10-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable