files.com 1.1.148 → 1.1.149

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: 01b556c1e4110c4fe2f19c4eb3cc837666d96b8bf9aa5dfab43134f84a195396
4
- data.tar.gz: 39fad710efe27bdce3e25c9912d9555da07169fa183610c23ed50abad7f46733
3
+ metadata.gz: 10fbda85aaebf20a675954a777aef95ebbddb70ca27153bae15fc72e8f1e9b9f
4
+ data.tar.gz: a5b9f65d1f04237f2d9a27f9f4173f8441f43272ac1cfbd305342ddaeb70c866
5
5
  SHA512:
6
- metadata.gz: 00047fb734bcfd0311b8e7fb14876490f4535515c0161b600f7702673c72cfd606d1287b274b75a820efb9650605ed456782b3a1222d6add89cdce62e6387f2f
7
- data.tar.gz: 50374ba0bb21964bd0507c05a8ef9415864eae085f0c1f976583ef6e641ae6da83532143ff041293c870dc070f4cee48cadfe494bfae79ffa39c18d03efeb06a
6
+ metadata.gz: b1e4cf5b61e39768d19af342595e09fcb0f0d882d3639d93985f45c503a57a4e22326804e8146f822c5c18d12fe39689c485bef2f6a4e585b60ec0bf2623d465
7
+ data.tar.gz: 0b79895ad9e6df66452797aa3eb112741fdf49bf16571ee85bd4f6c3c0cc0e9986a14580e77ce5781edef6a9b135ed27eccab09adf91304eb4db8016fefb297f
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.148
1
+ 1.1.149
data/docs/permission.md CHANGED
@@ -62,18 +62,20 @@ Files::Permission.create(
62
62
  permission: "full",
63
63
  recursive: true,
64
64
  user_id: 1,
65
- username: "user"
65
+ username: "user",
66
+ group_name: "example"
66
67
  )
67
68
  ```
68
69
 
69
70
  ### Parameters
70
71
 
71
72
  * `path` (string): Required - Folder path
72
- * `group_id` (int64): Group ID
73
+ * `group_id` (int64): Group ID. Provide `group_name` or `group_id`
73
74
  * `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
74
75
  * `recursive` (boolean): Apply to subfolders recursively?
75
76
  * `user_id` (int64): User ID. Provide `username` or `user_id`
76
77
  * `username` (string): User username. Provide `username` or `user_id`
78
+ * `group_name` (string): Group name. Provide `group_name` or `group_id`
77
79
 
78
80
 
79
81
  ---
@@ -152,6 +152,9 @@ Files::RemoteServer.list
152
152
 
153
153
  * `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.
154
154
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
155
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
156
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, server_type ]`, `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
157
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
155
158
 
156
159
 
157
160
  ---
@@ -0,0 +1,36 @@
1
+ # UserSftpClientUse
2
+
3
+ ## Example UserSftpClientUse Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "sftp_client": "example",
9
+ "created_at": "2000-01-01T01:00:00Z",
10
+ "updated_at": "2000-01-01T01:00:00Z",
11
+ "user_id": 1
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): UserSftpClientUse ID
16
+ * `sftp_client` (string): The SFTP client used
17
+ * `created_at` (date-time): The earliest recorded use of this SFTP client (for this user)
18
+ * `updated_at` (date-time): The most recent use of this SFTP client (for this user)
19
+ * `user_id` (int64): ID of the user who performed this access
20
+
21
+
22
+ ---
23
+
24
+ ## List User SFTP Client Uses
25
+
26
+ ```
27
+ Files::UserSftpClientUse.list(
28
+ user_id: 1
29
+ )
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
35
+ * `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.
36
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -138,17 +138,19 @@ module Files
138
138
 
139
139
  # Parameters:
140
140
  # path (required) - string - Folder path
141
- # group_id - int64 - Group ID
141
+ # group_id - int64 - Group ID. Provide `group_name` or `group_id`
142
142
  # permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
143
143
  # recursive - boolean - Apply to subfolders recursively?
144
144
  # user_id - int64 - User ID. Provide `username` or `user_id`
145
145
  # username - string - User username. Provide `username` or `user_id`
146
+ # group_name - string - Group name. Provide `group_name` or `group_id`
146
147
  def self.create(params = {}, options = {})
147
148
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
148
149
  raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
149
150
  raise InvalidParameterError.new("Bad parameter: permission must be an String") if params[:permission] and !params[:permission].is_a?(String)
150
151
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
151
152
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
153
+ raise InvalidParameterError.new("Bad parameter: group_name must be an String") if params[:group_name] and !params[:group_name].is_a?(String)
152
154
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]
153
155
 
154
156
  response, options = Api.send_request("/permissions", :post, params, options)
@@ -884,9 +884,15 @@ module Files
884
884
  # Parameters:
885
885
  # 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.
886
886
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
887
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
888
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, server_type ]`, `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
889
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ name, backblaze_b2_bucket ]`, `[ name, google_cloud_storage_bucket ]`, `[ name, wasabi_bucket ]`, `[ name, s3_bucket ]`, `[ name, rackspace_container ]`, `[ name, azure_blob_storage_container ]`, `[ name, azure_files_storage_share_name ]`, `[ name, s3_compatible_bucket ]`, `[ name, filebase_bucket ]`, `[ name, cloudflare_bucket ]` or `[ name, linode_bucket ]`.
887
890
  def self.list(params = {}, options = {})
888
891
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
889
892
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
893
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
894
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
895
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
890
896
 
891
897
  List.new(RemoteServer, params) do
892
898
  Api.send_request("/remote_servers", :get, params, options)
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class UserSftpClientUse
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - UserSftpClientUse ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # string - The SFTP client used
18
+ def sftp_client
19
+ @attributes[:sftp_client]
20
+ end
21
+
22
+ # date-time - The earliest recorded use of this SFTP client (for this user)
23
+ def created_at
24
+ @attributes[:created_at]
25
+ end
26
+
27
+ # date-time - The most recent use of this SFTP client (for this user)
28
+ def updated_at
29
+ @attributes[:updated_at]
30
+ end
31
+
32
+ # int64 - ID of the user who performed this access
33
+ def user_id
34
+ @attributes[:user_id]
35
+ end
36
+
37
+ # Parameters:
38
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
39
+ # 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.
40
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
+ def self.list(params = {}, options = {})
42
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
43
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
44
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
45
+
46
+ List.new(UserSftpClientUse, params) do
47
+ Api.send_request("/user_sftp_client_uses", :get, params, options)
48
+ end
49
+ end
50
+
51
+ def self.all(params = {}, options = {})
52
+ list(params, options)
53
+ end
54
+ end
55
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.148"
4
+ VERSION = "1.1.149"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -125,6 +125,7 @@ require "files.com/models/usage_snapshot"
125
125
  require "files.com/models/user"
126
126
  require "files.com/models/user_cipher_use"
127
127
  require "files.com/models/user_request"
128
+ require "files.com/models/user_sftp_client_use"
128
129
  require "files.com/models/web_dav_action_log"
129
130
  require "files.com/models/webhook_test"
130
131
 
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.148
4
+ version: 1.1.149
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-08 00:00:00.000000000 Z
11
+ date: 2024-10-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -208,6 +208,7 @@ files:
208
208
  - docs/user.md
209
209
  - docs/user_cipher_use.md
210
210
  - docs/user_request.md
211
+ - docs/user_sftp_client_use.md
211
212
  - docs/web_dav_action_log.md
212
213
  - docs/webhook_test.md
213
214
  - files.com.gemspec
@@ -311,6 +312,7 @@ files:
311
312
  - lib/files.com/models/user.rb
312
313
  - lib/files.com/models/user_cipher_use.rb
313
314
  - lib/files.com/models/user_request.rb
315
+ - lib/files.com/models/user_sftp_client_use.rb
314
316
  - lib/files.com/models/web_dav_action_log.rb
315
317
  - lib/files.com/models/webhook_test.rb
316
318
  - lib/files.com/path_util.rb