files.com 1.1.147 → 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: bb798851ff19d0a3d0d0edca0d08bc4a8c4e110df74f55cb99a7000195abafc7
4
- data.tar.gz: ef479ae58069b1edc3d6013e54051e4c7355ed9fb83a7b69dbda25057a621e07
3
+ metadata.gz: 10fbda85aaebf20a675954a777aef95ebbddb70ca27153bae15fc72e8f1e9b9f
4
+ data.tar.gz: a5b9f65d1f04237f2d9a27f9f4173f8441f43272ac1cfbd305342ddaeb70c866
5
5
  SHA512:
6
- metadata.gz: 5b3d99aad929ef1185dc3461c5394a1af82a8c12ff29df98ad964a8902e98df6b590a8b9ea5a6d25427f451cb2020b8d6e64b7234a91ed8e49567b0cd3e5d4f2
7
- data.tar.gz: f49779d948ad5ae25f774ec4d24ae6f37b96b415fefc0dc178cb2e49f0869d2476b8c0bf81193a82e0640685d19b8ef389a86d76ff6cb07cb6bde7a74d2baff1
6
+ metadata.gz: b1e4cf5b61e39768d19af342595e09fcb0f0d882d3639d93985f45c503a57a4e22326804e8146f822c5c18d12fe39689c485bef2f6a4e585b60ec0bf2623d465
7
+ data.tar.gz: 0b79895ad9e6df66452797aa3eb112741fdf49bf16571ee85bd4f6c3c0cc0e9986a14580e77ce5781edef6a9b135ed27eccab09adf91304eb4db8016fefb297f
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.147
1
+ 1.1.149
data/docs/automation.md CHANGED
@@ -104,9 +104,7 @@
104
104
  ## List Automations
105
105
 
106
106
  ```
107
- Files::Automation.list(
108
- with_deleted: true
109
- )
107
+ Files::Automation.list
110
108
  ```
111
109
 
112
110
  ### Parameters
@@ -119,7 +117,6 @@ Files::Automation.list(
119
117
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
120
118
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
121
119
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
122
- * `with_deleted` (boolean): Set to true to include deleted automations in the results.
123
120
 
124
121
 
125
122
  ---
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
  ---
data/docs/site.md CHANGED
@@ -56,6 +56,7 @@
56
56
  "dav_enabled": true,
57
57
  "dav_user_root_enabled": true,
58
58
  "days_to_retain_backups": 30,
59
+ "document_edits_in_bundle_allowed": "example",
59
60
  "default_time_zone": "Pacific Time (US & Canada)",
60
61
  "desktop_app": true,
61
62
  "desktop_app_session_ip_pinning": true,
@@ -329,6 +330,7 @@
329
330
  * `dav_enabled` (boolean): Is WebDAV enabled?
330
331
  * `dav_user_root_enabled` (boolean): Use user FTP roots also for WebDAV?
331
332
  * `days_to_retain_backups` (int64): Number of days to keep deleted files
333
+ * `document_edits_in_bundle_allowed` (string): If true, allow public viewers of Bundles with full permissions to use document editing integrations.
332
334
  * `default_time_zone` (string): Site default time zone
333
335
  * `desktop_app` (boolean): Is the desktop app enabled?
334
336
  * `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
@@ -382,8 +384,8 @@
382
384
  * `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
383
385
  * `next_billing_amount` (double): Next billing amount
384
386
  * `next_billing_date` (string): Next billing date
385
- * `office_integration_available` (boolean): Allow users to use Office for the web?
386
- * `office_integration_type` (string): Office integration application used to edit and view the MS Office documents
387
+ * `office_integration_available` (boolean): If true, allows users to use a document editing integration.
388
+ * `office_integration_type` (string): Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
387
389
  * `oncehub_link` (string): Link to scheduling a meeting with our Sales team
388
390
  * `opt_out_global` (boolean): Use servers in the USA only?
389
391
  * `overdue` (boolean): Is this site's billing overdue?
@@ -544,6 +546,7 @@ Files::Site.update(
544
546
  bundle_registration_notifications: "never",
545
547
  bundle_activity_notifications: "never",
546
548
  bundle_upload_receipt_notifications: "never",
549
+ document_edits_in_bundle_allowed: "example",
547
550
  password_requirements_apply_to_bundles: true,
548
551
  prevent_root_permissions_for_non_site_admins: true,
549
552
  opt_out_global: true,
@@ -649,8 +652,8 @@ Files::Site.update(
649
652
  * `mobile_app_session_lifetime` (int64): Mobile app session lifetime (in hours)
650
653
  * `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
651
654
  * `welcome_screen` (string): Does the welcome screen appear?
652
- * `office_integration_available` (boolean): Allow users to use Office for the web?
653
- * `office_integration_type` (string): Office integration application used to edit and view the MS Office documents
655
+ * `office_integration_available` (boolean): If true, allows users to use a document editing integration.
656
+ * `office_integration_type` (string): Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
654
657
  * `pin_all_remote_servers_to_site_region` (boolean): If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
655
658
  * `motd_text` (string): A message to show users when they connect via FTP or SFTP.
656
659
  * `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
@@ -694,6 +697,7 @@ Files::Site.update(
694
697
  * `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
695
698
  * `bundle_activity_notifications` (string): Do Bundle owners receive activity notifications?
696
699
  * `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
700
+ * `document_edits_in_bundle_allowed` (string): If true, allow public viewers of Bundles with full permissions to use document editing integrations.
697
701
  * `password_requirements_apply_to_bundles` (boolean): Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
698
702
  * `prevent_root_permissions_for_non_site_admins` (boolean): If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
699
703
  * `opt_out_global` (boolean): Use servers in the USA only?
@@ -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).
@@ -419,7 +419,6 @@ module Files
419
419
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
420
420
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
421
421
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
422
- # with_deleted - boolean - Set to true to include deleted automations in the results.
423
422
  def self.list(params = {}, options = {})
424
423
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
425
424
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -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)
@@ -224,6 +224,11 @@ module Files
224
224
  @attributes[:days_to_retain_backups]
225
225
  end
226
226
 
227
+ # string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
228
+ def document_edits_in_bundle_allowed
229
+ @attributes[:document_edits_in_bundle_allowed]
230
+ end
231
+
227
232
  # string - Site default time zone
228
233
  def default_time_zone
229
234
  @attributes[:default_time_zone]
@@ -489,12 +494,12 @@ module Files
489
494
  @attributes[:next_billing_date]
490
495
  end
491
496
 
492
- # boolean - Allow users to use Office for the web?
497
+ # boolean - If true, allows users to use a document editing integration.
493
498
  def office_integration_available
494
499
  @attributes[:office_integration_available]
495
500
  end
496
501
 
497
- # string - Office integration application used to edit and view the MS Office documents
502
+ # string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
498
503
  def office_integration_type
499
504
  @attributes[:office_integration_type]
500
505
  end
@@ -852,8 +857,8 @@ module Files
852
857
  # mobile_app_session_lifetime - int64 - Mobile app session lifetime (in hours)
853
858
  # folder_permissions_groups_only - boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
854
859
  # welcome_screen - string - Does the welcome screen appear?
855
- # office_integration_available - boolean - Allow users to use Office for the web?
856
- # office_integration_type - string - Office integration application used to edit and view the MS Office documents
860
+ # office_integration_available - boolean - If true, allows users to use a document editing integration.
861
+ # office_integration_type - string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
857
862
  # pin_all_remote_servers_to_site_region - boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
858
863
  # motd_text - string - A message to show users when they connect via FTP or SFTP.
859
864
  # motd_use_for_ftp - boolean - Show message to users connecting via FTP
@@ -897,6 +902,7 @@ module Files
897
902
  # bundle_registration_notifications - string - Do Bundle owners receive registration notification?
898
903
  # bundle_activity_notifications - string - Do Bundle owners receive activity notifications?
899
904
  # bundle_upload_receipt_notifications - string - Do Bundle uploaders receive upload confirmation notifications?
905
+ # document_edits_in_bundle_allowed - string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
900
906
  # password_requirements_apply_to_bundles - boolean - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
901
907
  # prevent_root_permissions_for_non_site_admins - boolean - If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
902
908
  # opt_out_global - boolean - Use servers in the USA only?
@@ -1015,6 +1021,7 @@ module Files
1015
1021
  raise InvalidParameterError.new("Bad parameter: bundle_registration_notifications must be an String") if params[:bundle_registration_notifications] and !params[:bundle_registration_notifications].is_a?(String)
1016
1022
  raise InvalidParameterError.new("Bad parameter: bundle_activity_notifications must be an String") if params[:bundle_activity_notifications] and !params[:bundle_activity_notifications].is_a?(String)
1017
1023
  raise InvalidParameterError.new("Bad parameter: bundle_upload_receipt_notifications must be an String") if params[:bundle_upload_receipt_notifications] and !params[:bundle_upload_receipt_notifications].is_a?(String)
1024
+ raise InvalidParameterError.new("Bad parameter: document_edits_in_bundle_allowed must be an String") if params[:document_edits_in_bundle_allowed] and !params[:document_edits_in_bundle_allowed].is_a?(String)
1018
1025
  raise InvalidParameterError.new("Bad parameter: disable_users_from_inactivity_period_days must be an Integer") if params[:disable_users_from_inactivity_period_days] and !params[:disable_users_from_inactivity_period_days].is_a?(Integer)
1019
1026
  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)
1020
1027
  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)
@@ -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.147"
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.147
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-07 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