files.com 1.2.77 → 1.2.79

package/_VERSION

@@ -1 +1 @@
-1.2.77
+1.2.79

package/docs/models/AccountLineItem.md

@@ -44,9 +44,9 @@
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `invoice_line_items` (array): Associated invoice line items
+* `invoice_line_items` (array(object)): Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items` (array(object)): Associated payment line items
 * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
 * `payment_type` (string): Type of payment if applicable
 * `site_name` (string): Site name this line item is for

package/docs/models/Action.md

@@ -29,7 +29,7 @@
 * `display` (string): Friendly displayed output
 * `ip` (string): IP Address that performed this action
 * `source` (string): The source path for this action, if applicable
-* `targets` (array): Targets
+* `targets` (array(object)): Targets
 * `user_id` (int64): User ID
 * `username` (string): Username
 * `action` (string): Type of action

package/docs/models/ApiKey.md

@@ -134,7 +134,7 @@ await ApiKey.deleteCurrent
 ## Update Api Key
 
 ```
-const [api_key] = await ApiKey.list()
+const api_key = await ApiKey.find(id)
 
 await api_key.update({
   'description': "example",
@@ -176,7 +176,7 @@ await api_key.update({
 ## Delete Api Key
 
 ```
-const [api_key] = await ApiKey.list()
+const api_key = await ApiKey.find(id)
 
 await api_key.delete()
 ```

package/docs/models/App.md

@@ -46,7 +46,7 @@
 * `name` (string): Name of the App
 * `package_manager_install_command` (string): Package manager install command
 * `remote_server_type` (string): Associated Remote Server type, if any
-* `screenshot_list_urls` (array): Screenshots of the App
+* `screenshot_list_urls` (array(string)): Screenshots of the App
 * `sdk_installation_instructions_link` (string): Link to SDK installation instructions
 * `short_description` (string): Short description of the App
 * `sso_strategy_type` (string): Associated SSO Strategy type, if any

package/docs/models/As2Partner.md

@@ -98,7 +98,7 @@ await As2Partner.create({
 ## Update As2 Partner
 
 ```
-const [as2_partner] = await As2Partner.list()
+const as2_partner = await As2Partner.find(id)
 
 await as2_partner.update({
   'name': "AS2 Partner Name",
@@ -145,7 +145,7 @@ await as2_partner.update({
 ## Delete As2 Partner
 
 ```
-const [as2_partner] = await As2Partner.list()
+const as2_partner = await As2Partner.find(id)
 
 await as2_partner.delete()
 ```

package/docs/models/As2Station.md

@@ -91,7 +91,7 @@ await As2Station.create({
 ## Update As2 Station
 
 ```
-const [as2_station] = await As2Station.list()
+const as2_station = await As2Station.find(id)
 
 await as2_station.update({
   'name': "AS2 Station Name",
@@ -131,7 +131,7 @@ await as2_station.update({
 ## Delete As2 Station
 
 ```
-const [as2_station] = await As2Station.list()
+const as2_station = await As2Station.find(id)
 
 await as2_station.delete()
 ```

package/docs/models/Automation.md

@@ -68,10 +68,10 @@
 * `description` (string): Description for the this Automation.
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
-* `destinations` (array): Destination Paths
+* `destinations` (array(string)): Destination Paths
 * `disabled` (boolean): If true, this automation will not run.
 * `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
-* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
+* `group_ids` (array(int64)): IDs of Groups for the Automation (i.e. who to Request File from)
 * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
 * `interval` (string): If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
 * `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
@@ -82,15 +82,15 @@
 * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
 * `human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
-* `schedule_days_of_week` (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.
-* `schedule_times_of_day` (array): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
+* `schedule_days_of_week` (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.
+* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
 * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
 * `source` (string): Source Path
-* `sync_ids` (array): IDs of remote sync folder behaviors to run by this Automation
-* `trigger_actions` (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
+* `sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
+* `trigger_actions` (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
 * `trigger` (string): How this automation is triggered to run.
 * `user_id` (int64): User ID of the Automation's creator.
-* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
+* `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
 * `value` (object): A Hash of attributes specific to the automation type.
 * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
 * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
@@ -201,7 +201,7 @@ await Automation.create({
 ## Manually run automation
 
 ```
-const [automation] = await Automation.list()
+const automation = await Automation.find(id)
 
 await automation.manual_run()
 ```
@@ -216,7 +216,7 @@ await automation.manual_run()
 ## Update Automation
 
 ```
-const [automation] = await Automation.list()
+const automation = await Automation.find(id)
 
 await automation.update({
   'source': "source",
@@ -343,7 +343,7 @@ await automation.update({
 ## Delete Automation
 
 ```
-const [automation] = await Automation.list()
+const automation = await Automation.find(id)
 
 await automation.delete()
 ```

package/docs/models/Behavior.md

@@ -143,7 +143,7 @@ await Behavior.webhookTest({
 ## Update Behavior
 
 ```
-const [behavior] = await Behavior.list()
+const behavior = await Behavior.find(id)
 
 await behavior.update({
   'value': "{\"method\": \"GET\"}",
@@ -193,7 +193,7 @@ await behavior.update({
 ## Delete Behavior
 
 ```
-const [behavior] = await Behavior.list()
+const behavior = await Behavior.find(id)
 
 await behavior.delete()
 ```

package/docs/models/Bundle.md

@@ -123,8 +123,8 @@
 * `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
 * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 * `has_inbox` (boolean): Does this bundle have an associated inbox?
-* `paths` (array): A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
-* `bundlepaths` (array): A list of bundlepaths in this bundle.  For performance reasons, this is not provided when listing bundles.
+* `paths` (array(string)): A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
+* `bundlepaths` (array(object)): A list of bundlepaths in this bundle.  For performance reasons, this is not provided when listing bundles.
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
@@ -240,7 +240,7 @@ await Bundle.create({
 ## Send email(s) with a link to bundle
 
 ```
-const [bundle] = await Bundle.list()
+const bundle = await Bundle.find(id)
 
 await bundle.share({
   'to': ["johndoe@gmail.com"],
@@ -262,7 +262,7 @@ await bundle.share({
 ## Update Bundle
 
 ```
-const [bundle] = await Bundle.list()
+const bundle = await Bundle.find(id)
 
 await bundle.update({
   'paths': ["file.txt"],
@@ -414,7 +414,7 @@ await bundle.update({
 ## Delete Bundle
 
 ```
-const [bundle] = await Bundle.list()
+const bundle = await Bundle.find(id)
 
 await bundle.delete()
 ```

package/docs/models/BundleNotification.md

@@ -75,7 +75,7 @@ await BundleNotification.create({
 ## Update Bundle Notification
 
 ```
-const [bundle_notification] = await BundleNotification.list()
+const bundle_notification = await BundleNotification.find(id)
 
 await bundle_notification.update({
   'notify_on_registration': true,
@@ -106,7 +106,7 @@ await bundle_notification.update({
 ## Delete Bundle Notification
 
 ```
-const [bundle_notification] = await BundleNotification.list()
+const bundle_notification = await BundleNotification.find(id)
 
 await bundle_notification.delete()
 ```

package/docs/models/Clickwrap.md

@@ -77,7 +77,7 @@ await Clickwrap.create({
 ## Update Clickwrap
 
 ```
-const [clickwrap] = await Clickwrap.list()
+const clickwrap = await Clickwrap.find(id)
 
 await clickwrap.update({
   'name': "Example Site NDA for Files.com Use",
@@ -115,7 +115,7 @@ await clickwrap.update({
 ## Delete Clickwrap
 
 ```
-const [clickwrap] = await Clickwrap.list()
+const clickwrap = await Clickwrap.find(id)
 
 await clickwrap.delete()
 ```

package/docs/models/Errors.md

@@ -13,5 +13,5 @@
 }
 ```
 
-* `fields` (array): A list of fields where errors occur
-* `messages` (array): A list of error messages
+* `fields` (array(string)): A list of fields where errors occur
+* `messages` (array(string)): A list of error messages

package/docs/models/File.md

@@ -150,8 +150,7 @@ await File.find(path, {
 ## Download file
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.download({
   'with_previews': true,
@@ -220,8 +219,7 @@ await file.download({
 ## Update file/folder metadata
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.update({
   'custom_metadata': {"key":"value"},
@@ -290,8 +288,7 @@ await file.update({
 ## Delete file/folder
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.delete({
   'recursive': true,
@@ -309,8 +306,7 @@ await file.delete({
 ## Copy file/folder
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.copy({
   'destination': "destination",
@@ -340,8 +336,7 @@ await file.copy({
 ## Move file/folder
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.move({
   'destination': "destination",
@@ -369,8 +364,7 @@ await file.move({
 ## Begin file upload
 
 ```
-const file = new File()
-file.path = myFilePath
+const file = await File.find(path)
 
 await file.begin_upload({
   'mkdir_parents': true,

package/docs/models/FileComment.md

@@ -17,7 +17,7 @@
 
 * `id` (int64): File Comment ID
 * `body` (string): Comment body.
-* `reactions` (array): Reactions to this comment.
+* `reactions` (array(object)): Reactions to this comment.
 * `path` (string): File path.
 
 ---

package/docs/models/FormField.md

@@ -24,6 +24,6 @@
 * `required` (boolean): Is this a required field?
 * `help_text` (string): Help text to be displayed
 * `field_type` (string): Type of Field
-* `options_for_select` (array): Options to display for radio and dropdown
+* `options_for_select` (array(string)): Options to display for radio and dropdown
 * `default_option` (string): Default option for radio and dropdown
 * `form_field_set_id` (int64): Form field set id

package/docs/models/FormFieldSet.md

@@ -36,8 +36,8 @@
 
 * `id` (int64): Form field set id
 * `title` (string): Title to be displayed
-* `form_layout` (array): Layout of the form
-* `form_fields` (array): Associated form fields
+* `form_layout` (array(int64)): Layout of the form
+* `form_fields` (array(object)): Associated form fields
 * `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
 * `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
 * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
@@ -104,7 +104,7 @@ await FormFieldSet.create({
 ## Update Form Field Set
 
 ```
-const [form_field_set] = await FormFieldSet.list()
+const form_field_set = await FormFieldSet.find(id)
 
 await form_field_set.update({
   'title': "Sample Form Title",
@@ -163,7 +163,7 @@ await form_field_set.update({
 ## Delete Form Field Set
 
 ```
-const [form_field_set] = await FormFieldSet.list()
+const form_field_set = await FormFieldSet.find(id)
 
 await form_field_set.delete()
 ```

package/docs/models/GpgKey.md

@@ -82,7 +82,7 @@ await GpgKey.create({
 ## Update Gpg Key
 
 ```
-const [gpg_key] = await GpgKey.list()
+const gpg_key = await GpgKey.find(id)
 
 await gpg_key.update({
   'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
@@ -119,7 +119,7 @@ await gpg_key.update({
 ## Delete Gpg Key
 
 ```
-const [gpg_key] = await GpgKey.list()
+const gpg_key = await GpgKey.find(id)
 
 await gpg_key.delete()
 ```

package/docs/models/Group.md

@@ -99,7 +99,7 @@ await Group.create({
 ## Update Group
 
 ```
-const [group] = await Group.list()
+const group = await Group.find(id)
 
 await group.update({
   'notes': "example",
@@ -150,7 +150,7 @@ await group.update({
 ## Delete Group
 
 ```
-const [group] = await Group.list()
+const group = await Group.find(id)
 
 await group.delete()
 ```

package/docs/models/GroupUser.md

@@ -18,7 +18,7 @@
 * `group_id` (int64): Group ID
 * `user_id` (int64): User ID
 * `admin` (boolean): Is this user an administrator of this group?
-* `usernames` (array): A list of usernames for users in this group
+* `usernames` (array(string)): A list of usernames for users in this group
 * `id` (int64): Group User ID.
 
 ---

package/docs/models/History.md

@@ -29,7 +29,7 @@
 * `display` (string): Friendly displayed output
 * `ip` (string): IP Address that performed this action
 * `source` (string): The source path for this action, if applicable
-* `targets` (array): Targets
+* `targets` (array(object)): Targets
 * `user_id` (int64): User ID
 * `username` (string): Username
 * `action` (string): Type of action

package/docs/models/Invoice.md

@@ -44,9 +44,9 @@
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `invoice_line_items` (array): Associated invoice line items
+* `invoice_line_items` (array(object)): Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items` (array(object)): Associated payment line items
 * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
 * `payment_type` (string): Type of payment if applicable
 * `site_name` (string): Site name this line item is for

package/docs/models/IpAddress.md

@@ -16,7 +16,7 @@
 * `id` (string): Unique label for list; used by Zapier and other integrations.
 * `associated_with` (string): The object that this public IP address list is associated with.
 * `group_id` (int64): Group ID
-* `ip_addresses` (array): A list of IP addresses.
+* `ip_addresses` (array(string)): A list of IP addresses.
 
 ---
 

package/docs/models/Message.md

@@ -25,7 +25,7 @@
 * `id` (int64): Message ID
 * `subject` (string): Message subject.
 * `body` (string): Message body.
-* `comments` (array): Comments.
+* `comments` (array(object)): Comments.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `project_id` (int64): Project to which the message should be attached.
 
@@ -88,7 +88,7 @@ await Message.create({
 ## Update Message
 
 ```
-const [message] = await Message.list()
+const message = await Message.find(id)
 
 await message.update({
   'project_id': 1,
@@ -131,7 +131,7 @@ await message.update({
 ## Delete Message
 
 ```
-const [message] = await Message.list()
+const message = await Message.find(id)
 
 await message.delete()
 ```

package/docs/models/MessageComment.md

@@ -17,7 +17,7 @@
 
 * `id` (int64): Message Comment ID
 * `body` (string): Comment body.
-* `reactions` (array): Reactions to this comment.
+* `reactions` (array(object)): Reactions to this comment.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 ---
@@ -75,7 +75,7 @@ await MessageComment.create({
 ## Update Message Comment
 
 ```
-const [message_comment] = await MessageComment.list()
+const message_comment = await MessageComment.find(id)
 
 await message_comment.update({
   'body': "body",
@@ -107,7 +107,7 @@ await message_comment.update({
 ## Delete Message Comment
 
 ```
-const [message_comment] = await MessageComment.list()
+const message_comment = await MessageComment.find(id)
 
 await message_comment.delete()
 ```

package/docs/models/MessageCommentReaction.md

@@ -68,7 +68,7 @@ await MessageCommentReaction.create({
 ## Delete Message Comment Reaction
 
 ```
-const [message_comment_reaction] = await MessageCommentReaction.list()
+const message_comment_reaction = await MessageCommentReaction.find(id)
 
 await message_comment_reaction.delete()
 ```

package/docs/models/MessageReaction.md

@@ -68,7 +68,7 @@ await MessageReaction.create({
 ## Delete Message Reaction
 
 ```
-const [message_reaction] = await MessageReaction.list()
+const message_reaction = await MessageReaction.find(id)
 
 await message_reaction.delete()
 ```

package/docs/models/Notification.md

@@ -40,8 +40,8 @@
 * `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `group_id` (int64): ID of Group to receive notifications
 * `group_name` (string): Group name, if a Group ID is set
-* `triggering_group_ids` (array): If set, will only notify on actions made by a member of one of the specified groups
-* `triggering_user_ids` (array): If set, will onlynotify on actions made one of the specified users
+* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
+* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
 * `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
 * `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user.  If false, only activity performed by other users (or anonymous users) will be sent in notifications.
 * `notify_on_copy` (boolean): Trigger on files copied to this path?
@@ -52,7 +52,7 @@
 * `recursive` (boolean): Apply notification recursively?  This will enable notifications for each subfolder.
 * `send_interval` (string): The time interval that notifications are aggregated to
 * `message` (string): Custom message to include in notification emails
-* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to scope trigger
+* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
 * `unsubscribed` (boolean): Is the user unsubscribed from this notification?
 * `unsubscribed_reason` (string): The reason that the user unsubscribed
 * `user_id` (int64): Notification user ID
@@ -149,7 +149,7 @@ await Notification.create({
 ## Update Notification
 
 ```
-const [notification] = await Notification.list()
+const notification = await Notification.find(id)
 
 await notification.update({
   'notify_on_copy': true,
@@ -226,7 +226,7 @@ await notification.update({
 ## Delete Notification
 
 ```
-const [notification] = await Notification.list()
+const notification = await Notification.find(id)
 
 await notification.delete()
 ```

package/docs/models/Payment.md

@@ -44,9 +44,9 @@
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `invoice_line_items` (array): Associated invoice line items
+* `invoice_line_items` (array(object)): Associated invoice line items
 * `method` (string): Line item payment method
-* `payment_line_items` (array): Associated payment line items
+* `payment_line_items` (array(object)): Associated payment line items
 * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
 * `payment_type` (string): Type of payment if applicable
 * `site_name` (string): Site name this line item is for

package/docs/models/Project.md

@@ -61,7 +61,7 @@ await Project.create({
 ## Update Project
 
 ```
-const [project] = await Project.list()
+const project = await Project.find(id)
 
 await project.update({
   'global_access': "global_access",
@@ -87,7 +87,7 @@ await project.update({
 ## Delete Project
 
 ```
-const [project] = await Project.list()
+const project = await Project.find(id)
 
 await project.delete()
 ```

package/docs/models/PublicKey.md

@@ -78,7 +78,7 @@ await PublicKey.create({
 ## Update Public Key
 
 ```
-const [public_key] = await PublicKey.list()
+const public_key = await PublicKey.find(id)
 
 await public_key.update({
   'title': "My Main Key",
@@ -109,7 +109,7 @@ await public_key.update({
 ## Delete Public Key
 
 ```
-const [public_key] = await PublicKey.list()
+const public_key = await PublicKey.find(id)
 
 await public_key.delete()
 ```

package/docs/models/RemoteServer.md

@@ -307,7 +307,7 @@ await RemoteServer.create({
 ## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
 
 ```
-const [remote_server] = await RemoteServer.list()
+const remote_server = await RemoteServer.find(id)
 
 await remote_server.configuration_file({
   'api_token': "example",
@@ -375,7 +375,7 @@ await remote_server.configuration_file({
 ## Update Remote Server
 
 ```
-const [remote_server] = await RemoteServer.list()
+const remote_server = await RemoteServer.find(id)
 
 await remote_server.update({
   'aws_access_key': "example",
@@ -563,7 +563,7 @@ await remote_server.update({
 ## Delete Remote Server
 
 ```
-const [remote_server] = await RemoteServer.list()
+const remote_server = await RemoteServer.find(id)
 
 await remote_server.delete()
 ```

package/docs/models/SettingsChange.md

@@ -15,7 +15,7 @@
 }
 ```
 
-* `changes` (array): Markdown-formatted change messages.
+* `changes` (array(string)): Markdown-formatted change messages.
 * `created_at` (date-time): The time this change was made
 * `user_id` (int64): The user id responsible for this change
 * `api_key_id` (int64): The api key id responsible for this change