files.com 1.1.82 → 1.1.84

data/docs/sftp_host_key.md

@@ -98,7 +98,7 @@ Files::SftpHostKey.delete(id)
 ## Update Sftp Host Key
 
 ```
-sftp_host_key = Files::SftpHostKey.list.first
+sftp_host_key = Files::SftpHostKey.find(id)
 
 sftp_host_key.update(
   name: "example"
@@ -117,7 +117,7 @@ sftp_host_key.update(
 ## Delete Sftp Host Key
 
 ```
-sftp_host_key = Files::SftpHostKey.list.first
+sftp_host_key = Files::SftpHostKey.find(id)
 
 sftp_host_key.delete
 ```

data/docs/share_group.md

@@ -22,7 +22,7 @@
 * `name` (string): Name of the share group
 * `notes` (string): Additional notes of the share group
 * `user_id` (int64): Owner User ID
-* `members` (array): A list of share group members
+* `members` (array(object)): A list of share group members
 
 
 ---
@@ -115,7 +115,7 @@ Files::ShareGroup.delete(id)
 ## Update Share Group
 
 ```
-share_group = Files::ShareGroup.list.first
+share_group = Files::ShareGroup.find(id)
 
 share_group.update(
   notes: "This group is defined for testing purposes",
@@ -137,7 +137,7 @@ share_group.update(
 ## Delete Share Group
 
 ```
-share_group = Files::ShareGroup.list.first
+share_group = Files::ShareGroup.find(id)
 
 share_group.delete
 ```

data/docs/site.md

@@ -282,7 +282,7 @@
 ```
 
 * `name` (string): Site name
-* `additional_text_file_types` (array): Additional extensions that are considered text files
+* `additional_text_file_types` (array(string)): Additional extensions that are considered text files
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
@@ -302,7 +302,7 @@
 * `bundle_expiration` (int64): Site-wide Bundle expiration in days
 * `bundle_not_found_message` (string): Custom error message to show when bundle is not found.
 * `bundle_password_required` (boolean): Do Bundles require password protection?
-* `bundle_recipient_blacklist_domains` (array): List of email domains to disallow when entering a Bundle/Inbox recipients
+* `bundle_recipient_blacklist_domains` (array(string)): List of email domains to disallow when entering a Bundle/Inbox recipients
 * `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?
 * `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
 * `bundle_require_registration` (boolean): Do Bundles require registration?

data/docs/snapshot.md

@@ -119,7 +119,7 @@ Files::Snapshot.delete(id)
 ## Finalize Snapshot
 
 ```
-snapshot = Files::Snapshot.list.first
+snapshot = Files::Snapshot.find(id)
 
 snapshot.finalize
 ```
@@ -134,7 +134,7 @@ snapshot.finalize
 ## Update Snapshot
 
 ```
-snapshot = Files::Snapshot.list.first
+snapshot = Files::Snapshot.find(id)
 
 snapshot.update(
   expires_at: "2000-01-01T01:00:00Z",
@@ -155,7 +155,7 @@ snapshot.update(
 ## Delete Snapshot
 
 ```
-snapshot = Files::Snapshot.list.first
+snapshot = Files::Snapshot.find(id)
 
 snapshot.delete
 ```

data/docs/sso_strategy.md

@@ -148,7 +148,7 @@ Files::SsoStrategy.sync(id)
 ## Synchronize provisioning data with the SSO remote server
 
 ```
-sso_strategy = Files::SsoStrategy.list.first
+sso_strategy = Files::SsoStrategy.find(id)
 
 sso_strategy.sync
 ```

data/docs/status.md

@@ -27,6 +27,6 @@
 * `message` (string): Error message
 * `status` (string): Status message
 * `data` (Auto): Additional data
-* `errors` (array): A list of api errors
+* `errors` (array(object)): A list of api errors
 * `clickwrap_id` (int64): Required Clickwrap id
 * `clickwrap_body` (string): Required Clickwrap body

data/docs/style.md

@@ -65,7 +65,7 @@ Files::Style.delete(path)
 ## Update Style
 
 ```
-style = Files::Style.new
+style = Files::Style.find(path)
 
 style.update(
   file: "file"
@@ -83,7 +83,7 @@ style.update(
 ## Delete Style
 
 ```
-style = Files::Style.new
+style = Files::Style.find(path)
 
 style.delete
 ```

data/docs/user.md

@@ -73,7 +73,7 @@
 
 * `id` (int64): User ID
 * `username` (string): User's username
-* `admin_group_ids` (array): List of group IDs of which this user is an administrator
+* `admin_group_ids` (array(int64)): List of group IDs of which this user is an administrator
 * `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
 * `attachments_permission` (boolean): DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
 * `api_keys_count` (int64): Number of api keys associated with this user
@@ -433,7 +433,7 @@ Files::User.delete(id)
 ## Unlock user who has been locked out due to failed logins
 
 ```
-user = Files::User.list.first
+user = Files::User.find(id)
 
 user.unlock
 ```
@@ -448,7 +448,7 @@ user.unlock
 ## Resend user welcome email
 
 ```
-user = Files::User.list.first
+user = Files::User.find(id)
 
 user.resend_welcome_email
 ```
@@ -463,7 +463,7 @@ user.resend_welcome_email
 ## Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
 
 ```
-user = Files::User.list.first
+user = Files::User.find(id)
 
 user.user_2fa_reset
 ```
@@ -478,7 +478,7 @@ user.user_2fa_reset
 ## Update User
 
 ```
-user = Files::User.list.first
+user = Files::User.find(id)
 
 user.update(
   avatar_delete: true,
@@ -577,7 +577,7 @@ user.update(
 ## Delete User
 
 ```
-user = Files::User.list.first
+user = Files::User.find(id)
 
 user.delete
 ```

data/docs/user_request.md

@@ -87,7 +87,7 @@ Files::UserRequest.delete(id)
 ## Delete User Request
 
 ```
-user_request = Files::UserRequest.list.first
+user_request = Files::UserRequest.find(id)
 
 user_request.delete
 ```

data/lib/files.com/models/account_line_item.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # array(object) - Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # array(object) - Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/action.rb

@@ -44,7 +44,7 @@ module Files
       @attributes[:source]
     end
 
-    # array - Targets
+    # array(object) - Targets
     def targets
       @attributes[:targets]
     end

data/lib/files.com/models/app.rb

@@ -84,7 +84,7 @@ module Files
       @attributes[:remote_server_type]
     end
 
-    # array - Screenshots of the App
+    # array(string) - Screenshots of the App
     def screenshot_list_urls
       @attributes[:screenshot_list_urls]
     end

data/lib/files.com/models/automation.rb

@@ -72,7 +72,7 @@ module Files
       @attributes[:destination_replace_to] = value
     end
 
-    # array - Destination Paths
+    # array(string) - Destination Paths
     def destinations
       @attributes[:destinations]
     end
@@ -99,7 +99,7 @@ module Files
       @attributes[:flatten_destination_structure] = value
     end
 
-    # array - IDs of Groups for the Automation (i.e. who to Request File from)
+    # array(int64) - IDs of Groups for the Automation (i.e. who to Request File from)
     def group_ids
       @attributes[:group_ids]
     end
@@ -198,7 +198,7 @@ module Files
       @attributes[:human_readable_schedule] = value
     end
 
-    # array - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
+    # array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
     def schedule_days_of_week
       @attributes[:schedule_days_of_week]
     end
@@ -207,7 +207,7 @@ module Files
       @attributes[:schedule_days_of_week] = value
     end
 
-    # array - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
+    # array(string) - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
     def schedule_times_of_day
       @attributes[:schedule_times_of_day]
     end
@@ -234,7 +234,7 @@ module Files
       @attributes[:source] = value
     end
 
-    # array - IDs of remote sync folder behaviors to run by this Automation
+    # array(int64) - IDs of remote sync folder behaviors to run by this Automation
     def sync_ids
       @attributes[:sync_ids]
     end
@@ -243,7 +243,7 @@ module Files
       @attributes[:sync_ids] = value
     end
 
-    # array - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
+    # array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
     def trigger_actions
       @attributes[:trigger_actions]
     end
@@ -270,7 +270,7 @@ module Files
       @attributes[:user_id] = value
     end
 
-    # array - IDs of Users for the Automation (i.e. who to Request File from)
+    # array(int64) - IDs of Users for the Automation (i.e. who to Request File from)
     def user_ids
       @attributes[:user_ids]
     end

data/lib/files.com/models/bundle.rb

@@ -338,7 +338,7 @@ module Files
       @attributes[:has_inbox] = value
     end
 
-    # array - A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
+    # array(string) - A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
     def paths
       @attributes[:paths]
     end
@@ -347,7 +347,7 @@ module Files
       @attributes[:paths] = value
     end
 
-    # array - A list of bundlepaths in this bundle.  For performance reasons, this is not provided when listing bundles.
+    # array(object) - A list of bundlepaths in this bundle.  For performance reasons, this is not provided when listing bundles.
     def bundlepaths
       @attributes[:bundlepaths]
     end

data/lib/files.com/models/errors.rb

@@ -9,12 +9,12 @@ module Files
       @options = options || {}
     end
 
-    # array - A list of fields where errors occur
+    # array(string) - A list of fields where errors occur
     def fields
       @attributes[:fields]
     end
 
-    # array - A list of error messages
+    # array(string) - A list of error messages
     def messages
       @attributes[:messages]
     end

data/lib/files.com/models/file_comment.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Reactions to this comment.
+    # array(object) - Reactions to this comment.
     def reactions
       @attributes[:reactions]
     end

data/lib/files.com/models/form_field.rb

@@ -34,7 +34,7 @@ module Files
       @attributes[:field_type]
     end
 
-    # array - Options to display for radio and dropdown
+    # array(string) - Options to display for radio and dropdown
     def options_for_select
       @attributes[:options_for_select]
     end

data/lib/files.com/models/form_field_set.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:title] = value
     end
 
-    # array - Layout of the form
+    # array(int64) - Layout of the form
     def form_layout
       @attributes[:form_layout]
     end
@@ -36,7 +36,7 @@ module Files
       @attributes[:form_layout] = value
     end
 
-    # array - Associated form fields
+    # array(object) - Associated form fields
     def form_fields
       @attributes[:form_fields]
     end

data/lib/files.com/models/group_user.rb

@@ -45,7 +45,7 @@ module Files
       @attributes[:admin] = value
     end
 
-    # array - A list of usernames for users in this group
+    # array(string) - A list of usernames for users in this group
     def usernames
       @attributes[:usernames]
     end

data/lib/files.com/models/history.rb

@@ -44,7 +44,7 @@ module Files
       @attributes[:source]
     end
 
-    # array - Targets
+    # array(object) - Targets
     def targets
       @attributes[:targets]
     end

data/lib/files.com/models/invoice.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # array(object) - Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # array(object) - Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/ip_address.rb

@@ -24,7 +24,7 @@ module Files
       @attributes[:group_id]
     end
 
-    # array - A list of IP addresses.
+    # array(string) - A list of IP addresses.
     def ip_addresses
       @attributes[:ip_addresses]
     end

data/lib/files.com/models/message.rb

@@ -36,7 +36,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Comments.
+    # array(object) - Comments.
     def comments
       @attributes[:comments]
     end

data/lib/files.com/models/message_comment.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:body] = value
     end
 
-    # array - Reactions to this comment.
+    # array(object) - Reactions to this comment.
     def reactions
       @attributes[:reactions]
     end

data/lib/files.com/models/notification.rb

@@ -45,7 +45,7 @@ module Files
       @attributes[:group_name] = value
     end
 
-    # array - If set, will only notify on actions made by a member of one of the specified groups
+    # array(int64) - If set, will only notify on actions made by a member of one of the specified groups
     def triggering_group_ids
       @attributes[:triggering_group_ids]
     end
@@ -54,7 +54,7 @@ module Files
       @attributes[:triggering_group_ids] = value
     end
 
-    # array - If set, will onlynotify on actions made one of the specified users
+    # array(int64) - If set, will onlynotify on actions made one of the specified users
     def triggering_user_ids
       @attributes[:triggering_user_ids]
     end
@@ -153,7 +153,7 @@ module Files
       @attributes[:message] = value
     end
 
-    # array - Array of filenames (possibly with wildcards) to scope trigger
+    # array(string) - Array of filenames (possibly with wildcards) to scope trigger
     def triggering_filenames
       @attributes[:triggering_filenames]
     end

data/lib/files.com/models/payment.rb

@@ -39,7 +39,7 @@ module Files
       @attributes[:download_uri]
     end
 
-    # array - Associated invoice line items
+    # array(object) - Associated invoice line items
     def invoice_line_items
       @attributes[:invoice_line_items]
     end
@@ -49,7 +49,7 @@ module Files
       @attributes[:method]
     end
 
-    # array - Associated payment line items
+    # array(object) - Associated payment line items
     def payment_line_items
       @attributes[:payment_line_items]
     end

data/lib/files.com/models/settings_change.rb

@@ -9,7 +9,7 @@ module Files
       @options = options || {}
     end
 
-    # array - Markdown-formatted change messages.
+    # array(string) - Markdown-formatted change messages.
     def changes
       @attributes[:changes]
     end

data/lib/files.com/models/share_group.rb

@@ -45,7 +45,7 @@ module Files
       @attributes[:user_id] = value
     end
 
-    # array - A list of share group members
+    # array(object) - A list of share group members
     def members
       @attributes[:members]
     end

data/lib/files.com/models/site.rb

@@ -14,7 +14,7 @@ module Files
       @attributes[:name]
     end
 
-    # array - Additional extensions that are considered text files
+    # array(string) - Additional extensions that are considered text files
     def additional_text_file_types
       @attributes[:additional_text_file_types]
     end
@@ -114,7 +114,7 @@ module Files
       @attributes[:bundle_password_required]
     end
 
-    # array - List of email domains to disallow when entering a Bundle/Inbox recipients
+    # array(string) - List of email domains to disallow when entering a Bundle/Inbox recipients
     def bundle_recipient_blacklist_domains
       @attributes[:bundle_recipient_blacklist_domains]
     end

data/lib/files.com/models/status.rb

@@ -29,7 +29,7 @@ module Files
       @attributes[:data]
     end
 
-    # array - A list of api errors
+    # array(object) - A list of api errors
     def errors
       @attributes[:errors]
     end

data/lib/files.com/models/user.rb

@@ -27,7 +27,7 @@ module Files
       @attributes[:username] = value
     end
 
-    # array - List of group IDs of which this user is an administrator
+    # array(int64) - List of group IDs of which this user is an administrator
     def admin_group_ids
       @attributes[:admin_group_ids]
     end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.82"
+  VERSION = "1.1.84"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.82
+  version: 1.1.84
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable