files.com 1.1.798 → 1.1.800

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: b037669a39c1f65e3ab224f3299cd664e10313b310e6f099c9f8482e14c1ffbd
4
- data.tar.gz: 65e0f35a26d36b6c6fceade4ac4d5d0dc1d90ad67b469e7ada0a8a21f23f75ef
3
+ metadata.gz: ecf1564e2813fd56763df9545809247fb73a123285654d284b29b6b3cdbeadea
4
+ data.tar.gz: c453ef450311badcb61e8cfc34191319d9b639a58dae3b7ed75644beb760b462
5
5
  SHA512:
6
- metadata.gz: fd8652bb96a4be6f14b9b7e63a632961fad99646f760331a18ca4165f31cb53a2f043c6770313560ed53d4ee8980c1307ec9f29d1ad5b022b3a7701639d359f7
7
- data.tar.gz: f94157b5a50ed09b839ae2210eab8101c15be6d80993117f1221d41cccd356025b5ec833e3d9b48c21c73152f02fcdc79e1eeb10be72568ad457abefc6297c71
6
+ metadata.gz: e307b3b237f636bdb9eff9a7f4a39eebd889ed7e1aa2999d003ad42e5373a53f602c379343aed244c622631d71177cf8712eaaefc37869ad3afb177adc60b561
7
+ data.tar.gz: fdd433d5d88ade5083a161d498be2bdd8afd386303a378dc8fd35ce8140fd989a87bedebae0d315d0a578f8eb09201f69efad6d18fcaeff0351651457b827120
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.798
1
+ 1.1.800
data/docs/api_key.md CHANGED
@@ -43,7 +43,7 @@
43
43
  * `url` (string): URL for API host.
44
44
  * `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
45
45
  * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
46
- * `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
46
+ * `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Does not grant access beyond the owning user's permissions. Optional for `files_only` keys and required for `office_integration` keys, which need a path the owning user can read. Keys with any other permission set cannot have a path.
47
47
 
48
48
 
49
49
  ---
@@ -115,7 +115,7 @@ Files::ApiKey.create(
115
115
  * `expires_at` (string): API Key expiration date
116
116
  * `name` (string): Required - Internal name for the API Key. For your use.
117
117
  * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
118
- * `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
118
+ * `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Does not grant access beyond the owning user's permissions. Optional for `files_only` keys and required for `office_integration` keys, which need a path the owning user can read. Keys with any other permission set cannot have a path.
119
119
  * `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `mobile_app` permission set can only perform the functions provided by our Mobile App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, excluding the GPG Encrypt and GPG Decrypt file actions, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user. Both GPG file actions and every other endpoint deny them with `not-authorized/api-key-only-for-file-operations`. Folder-configured GPG encryption and decryption still apply to files uploaded with a `files_only` key.
120
120
  * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
121
121
 
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "replayed_from_message_id": 1,
8
9
  "workspace_id": 1,
9
10
  "as2_partner_id": 1,
10
11
  "as2_station_id": 1,
@@ -46,7 +47,8 @@
46
47
  }
47
48
  ```
48
49
 
49
- * `id` (int64): Id of the AS2 Partner.
50
+ * `id` (int64): ID of this AS2 incoming message record.
51
+ * `replayed_from_message_id` (int64): ID of the incoming message record this message was replayed from. Empty for messages received directly from a trading partner.
50
52
  * `workspace_id` (int64): ID of the Workspace associated with this AS2 Incoming Message.
51
53
  * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
52
54
  * `as2_station_id` (int64): Id of the AS2 Station associated with this message.
@@ -101,3 +103,31 @@ Files::As2IncomingMessage.list
101
103
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
102
104
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
103
105
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
106
+
107
+
108
+ ---
109
+
110
+ ## Replay AS2 Incoming Message
111
+
112
+ ```
113
+ Files::As2IncomingMessage.replay(id)
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ * `id` (int64): Required - As2 Incoming Message ID.
119
+
120
+
121
+ ---
122
+
123
+ ## Replay AS2 Incoming Message
124
+
125
+ ```
126
+ as2_incoming_message = Files::As2IncomingMessage.list.first
127
+
128
+ as2_incoming_message.replay
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ * `id` (int64): Required - As2 Incoming Message ID.
data/docs/site.md CHANGED
@@ -37,6 +37,7 @@
37
37
  "allow_user_level_ssl_override": true,
38
38
  "allowed_countries": "US,DE",
39
39
  "allowed_ips": "example",
40
+ "enforce_parent_site_user_ip_restrictions": true,
40
41
  "always_mkdir_parents": false,
41
42
  "as2_message_retention_days": 1,
42
43
  "ask_about_overwrites": true,
@@ -398,6 +399,7 @@
398
399
  * `allow_user_level_ssl_override` (boolean): Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
399
400
  * `allowed_countries` (string): Comma separated list of allowed Country codes
400
401
  * `allowed_ips` (string): List of allowed IP addresses
402
+ * `enforce_parent_site_user_ip_restrictions` (boolean): Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.
401
403
  * `always_mkdir_parents` (boolean): Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
402
404
  * `as2_message_retention_days` (int64): Number of days to retain AS2 messages (incoming and outgoing).
403
405
  * `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
@@ -672,6 +674,7 @@ Files::Site.update(
672
674
  allow_user_level_2fa_override: false,
673
675
  allow_user_level_allowed_ip_override: false,
674
676
  allow_user_level_ssl_override: false,
677
+ enforce_parent_site_user_ip_restrictions: false,
675
678
  disallowed_countries: "US,DE",
676
679
  days_to_retain_backups: 1,
677
680
  max_prior_passwords: 1,
@@ -863,6 +866,7 @@ Files::Site.update(
863
866
  * `allow_user_level_2fa_override` (boolean): Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
864
867
  * `allow_user_level_allowed_ip_override` (boolean): Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
865
868
  * `allow_user_level_ssl_override` (boolean): Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
869
+ * `enforce_parent_site_user_ip_restrictions` (boolean): Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.
866
870
  * `disallowed_countries` (string): Comma separated list of disallowed Country codes
867
871
  * `days_to_retain_backups` (int64): Number of days to keep deleted files
868
872
  * `max_prior_passwords` (int64): Number of prior passwords to disallow
@@ -169,7 +169,7 @@ module Files
169
169
  @attributes[:workspace_id] = value
170
170
  end
171
171
 
172
- # string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
172
+ # string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Does not grant access beyond the owning user's permissions. Optional for `files_only` keys and required for `office_integration` keys, which need a path the owning user can read. Keys with any other permission set cannot have a path.
173
173
  def path
174
174
  @attributes[:path]
175
175
  end
@@ -303,7 +303,7 @@ module Files
303
303
  # expires_at - string - API Key expiration date
304
304
  # name (required) - string - Internal name for the API Key. For your use.
305
305
  # aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
306
- # path - string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
306
+ # path - string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Does not grant access beyond the owning user's permissions. Optional for `files_only` keys and required for `office_integration` keys, which need a path the owning user can read. Keys with any other permission set cannot have a path.
307
307
  # permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `mobile_app` permission set can only perform the functions provided by our Mobile App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, excluding the GPG Encrypt and GPG Decrypt file actions, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user. Both GPG file actions and every other endpoint deny them with `not-authorized/api-key-only-for-file-operations`. Folder-configured GPG encryption and decryption still apply to files uploaded with a `files_only` key.
308
308
  # workspace_id - int64 - Workspace ID for this API Key. `0` means the default workspace.
309
309
  #
@@ -11,11 +11,16 @@ module Files
11
11
  @options = options || {}
12
12
  end
13
13
 
14
- # int64 - Id of the AS2 Partner.
14
+ # int64 - ID of this AS2 incoming message record.
15
15
  def id
16
16
  @attributes[:id]
17
17
  end
18
18
 
19
+ # int64 - ID of the incoming message record this message was replayed from. Empty for messages received directly from a trading partner.
20
+ def replayed_from_message_id
21
+ @attributes[:replayed_from_message_id]
22
+ end
23
+
19
24
  # int64 - ID of the Workspace associated with this AS2 Incoming Message.
20
25
  def workspace_id
21
26
  @attributes[:workspace_id]
@@ -186,6 +191,19 @@ module Files
186
191
  @attributes[:mdn_response_uri]
187
192
  end
188
193
 
194
+ # Replay AS2 Incoming Message
195
+ def replay(params = {})
196
+ params = (params || {}).dup
197
+ params[:id] = @attributes[:id]
198
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
199
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if !params[:id].nil? and !params[:id].is_a?(Integer)
200
+ raise MissingParameterError.new("Parameter missing: id") if params[:id].nil?
201
+
202
+ response, options = Api.send_request("/as2_incoming_messages/#{@attributes[:id]}/replay", :post, params, @options)
203
+ @options = @options.merge(options)
204
+ [ response, options ]
205
+ end
206
+
189
207
  # Parameters:
190
208
  # 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.
191
209
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
@@ -221,5 +239,21 @@ module Files
221
239
  def self.all(params = {}, options = {})
222
240
  list(params, options)
223
241
  end
242
+
243
+ # Replay AS2 Incoming Message
244
+ #
245
+ # params:: Hash of API operation parameter values.
246
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
247
+ #
248
+ # Returns a Files::As2IncomingMessage.
249
+ def self.replay(id, params = {}, options = {})
250
+ params = (params || {}).dup
251
+ params[:id] = id
252
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if !params[:id].nil? and !params[:id].is_a?(Integer)
253
+ raise MissingParameterError.new("Parameter missing: id") if params[:id].nil?
254
+
255
+ response, options = Api.send_request("/as2_incoming_messages/#{params[:id]}/replay", :post, params, options) { |reply| reply.require_object("As2IncomingMessage") }
256
+ As2IncomingMessage.new(response.data, options)
257
+ end
224
258
  end
225
259
  end
@@ -108,6 +108,11 @@ module Files
108
108
  @attributes[:allowed_ips]
109
109
  end
110
110
 
111
+ # boolean - Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.
112
+ def enforce_parent_site_user_ip_restrictions
113
+ @attributes[:enforce_parent_site_user_ip_restrictions]
114
+ end
115
+
111
116
  # boolean - Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
112
117
  def always_mkdir_parents
113
118
  @attributes[:always_mkdir_parents]
@@ -1111,6 +1116,7 @@ module Files
1111
1116
  # allow_user_level_2fa_override - boolean - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
1112
1117
  # allow_user_level_allowed_ip_override - boolean - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
1113
1118
  # allow_user_level_ssl_override - boolean - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
1119
+ # enforce_parent_site_user_ip_restrictions - boolean - Require Parent Site users entering this Child Site to match its allowed IP addresses in addition to their existing IP restrictions. Applies to all Workspaces. Defaults to false.
1114
1120
  # disallowed_countries - string - Comma separated list of disallowed Country codes
1115
1121
  # days_to_retain_backups - int64 - Number of days to keep deleted files
1116
1122
  # max_prior_passwords - int64 - Number of prior passwords to disallow
@@ -1313,6 +1319,7 @@ module Files
1313
1319
  raise InvalidParameterError.new("Bad parameter: allow_user_level_2fa_override must be a single value, not #{params[:allow_user_level_2fa_override].class}") if [ Array, Hash ].any? { |klass| params[:allow_user_level_2fa_override].is_a?(klass) }
1314
1320
  raise InvalidParameterError.new("Bad parameter: allow_user_level_allowed_ip_override must be a single value, not #{params[:allow_user_level_allowed_ip_override].class}") if [ Array, Hash ].any? { |klass| params[:allow_user_level_allowed_ip_override].is_a?(klass) }
1315
1321
  raise InvalidParameterError.new("Bad parameter: allow_user_level_ssl_override must be a single value, not #{params[:allow_user_level_ssl_override].class}") if [ Array, Hash ].any? { |klass| params[:allow_user_level_ssl_override].is_a?(klass) }
1322
+ raise InvalidParameterError.new("Bad parameter: enforce_parent_site_user_ip_restrictions must be a single value, not #{params[:enforce_parent_site_user_ip_restrictions].class}") if [ Array, Hash ].any? { |klass| params[:enforce_parent_site_user_ip_restrictions].is_a?(klass) }
1316
1323
  raise InvalidParameterError.new("Bad parameter: disallowed_countries must be an String") if !params[:disallowed_countries].nil? and !params[:disallowed_countries].is_a?(String)
1317
1324
  raise InvalidParameterError.new("Bad parameter: days_to_retain_backups must be an Integer") if !params[:days_to_retain_backups].nil? and !params[:days_to_retain_backups].is_a?(Integer)
1318
1325
  raise InvalidParameterError.new("Bad parameter: max_prior_passwords must be an Integer") if !params[:max_prior_passwords].nil? and !params[:max_prior_passwords].is_a?(Integer)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.798
4
+ version: 1.1.800
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com