files.com 1.0.190 → 1.0.193

package/docs/models/Automation.md

@@ -0,0 +1,257 @@
+# Automation
+
+## Example Automation Object
+
+```
+{
+  "id": 1,
+  "automation": "create_folder",
+  "deleted": true,
+  "disabled": true,
+  "trigger": "realtime",
+  "interval": "week",
+  "last_modified_at": "2000-01-01T01:00:00Z",
+  "name": "",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "6:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  },
+  "source": "",
+  "destinations": [
+    "destination"
+  ],
+  "destination_replace_from": "",
+  "destination_replace_to": "",
+  "description": "",
+  "path": "",
+  "user_id": 1,
+  "user_ids": [
+    1,
+    2
+  ],
+  "group_ids": [
+    1,
+    2
+  ],
+  "webhook_url": "https://app.files.com/api/webhooks/abc123",
+  "trigger_actions": "[ \"create\" ]",
+  "value": "{\"limit\": \"1\"}"
+}
+```
+
+* `id` (int64): Automation ID
+* `automation` (string): Automation type
+* `deleted` (boolean): Indicates if the automation has been deleted.
+* `disabled` (boolean): If true, this automation will not run.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `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.
+* `name` (string): Name for this automation.
+* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
+* `source` (string): Source Path
+* `destinations` (string): Destination Path
+* `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.
+* `description` (string): Description for the this Automation.
+* `path` (string): Path on which this Automation runs.  Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `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)
+* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
+* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
+* `trigger_actions` (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
+* `value` (object): A Hash of attributes specific to the automation type.
+* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
+
+---
+
+## List Automations
+
+```
+await Automation.list({
+  'per_page': 1,
+  'with_deleted': true,
+  'automation': "create_folder",
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `automation`, `disabled` or `last_modified_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
+* `with_deleted` (boolean): Set to true to include deleted automations in the results.
+* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
+
+---
+
+## Show Automation
+
+```
+await Automation.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+
+---
+
+## Create Automation
+
+```
+await Automation.create({
+  'source': "source",
+  'destinations': "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
+  'interval': "year",
+  'user_ids': [1,2],
+  'group_ids': [1,2],
+  'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
+  'disabled': true,
+  'trigger': "realtime",
+  'trigger_actions': "[ \"create\" ]",
+  'value': "{\"limit\": \"1\"}",
+  'automation': "create_folder",
+})
+```
+
+
+### Parameters
+
+* `source` (string): Source Path
+* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
+* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
+* `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.
+* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+* `path` (string): Path on which this Automation runs.  Supports globs.
+* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `schedule` (object): Custom schedule for running this automation.
+* `description` (string): Description for the this Automation.
+* `disabled` (boolean): If true, this automation will not run.
+* `name` (string): Name for this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `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
+* `value` (object): A Hash of attributes specific to the automation type.
+* `automation` (string): Required - Automation type
+
+---
+
+## Update Automation
+
+```
+const [automation] = await Automation.list()
+
+await automation.update({
+  'source': "source",
+  'destinations': "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
+  'interval': "year",
+  'user_ids': [1,2],
+  'group_ids': [1,2],
+  'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
+  'disabled': true,
+  'trigger': "realtime",
+  'trigger_actions': "[ \"create\" ]",
+  'value': "{\"limit\": \"1\"}",
+  'automation': "create_folder",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+* `source` (string): Source Path
+* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
+* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
+* `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.
+* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+* `path` (string): Path on which this Automation runs.  Supports globs.
+* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `schedule` (object): Custom schedule for running this automation.
+* `description` (string): Description for the this Automation.
+* `disabled` (boolean): If true, this automation will not run.
+* `name` (string): Name for this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `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
+* `value` (object): A Hash of attributes specific to the automation type.
+* `automation` (string): Automation type
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "automation": "create_folder",
+  "deleted": true,
+  "disabled": true,
+  "trigger": "realtime",
+  "interval": "week",
+  "last_modified_at": "2000-01-01T01:00:00Z",
+  "name": "",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "6:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  },
+  "source": "",
+  "destinations": [
+    "destination"
+  ],
+  "destination_replace_from": "",
+  "destination_replace_to": "",
+  "description": "",
+  "path": "",
+  "user_id": 1,
+  "user_ids": [
+    1,
+    2
+  ],
+  "group_ids": [
+    1,
+    2
+  ],
+  "webhook_url": "https://app.files.com/api/webhooks/abc123",
+  "trigger_actions": "[ \"create\" ]",
+  "value": "{\"limit\": \"1\"}"
+}
+```
+
+---
+
+## Delete Automation
+
+```
+const [automation] = await Automation.list()
+
+await automation.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+

package/docs/models/AutomationRun.md

@@ -0,0 +1,61 @@
+# AutomationRun
+
+## Example AutomationRun Object
+
+```
+{
+  "id": 1,
+  "automation_id": 1,
+  "completed_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
+  "status": "success",
+  "status_messages_url": "https://www.example.com/log_file.txt"
+}
+```
+
+* `id` (int64): ID.
+* `automation_id` (int64): ID of the associated Automation.
+* `completed_at` (date-time): Automation run completion/failure date/time.
+* `created_at` (date-time): Automation run start date/time.
+* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+* `status_messages_url` (string): Link to status messages log file.
+
+---
+
+## List Automation Runs
+
+```
+await AutomationRun.list({
+  'user_id': 1,
+  'per_page': 1,
+  'automation_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
+* `automation_id` (int64): Required - ID of the associated Automation.
+
+---
+
+## Show Automation Run
+
+```
+await AutomationRun.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.

package/docs/models/BandwidthSnapshot.md

@@ -0,0 +1,50 @@
+# BandwidthSnapshot
+
+## Example BandwidthSnapshot Object
+
+```
+{
+  "id": 1,
+  "bytes_received": 1.0,
+  "bytes_sent": 1.0,
+  "sync_bytes_received": 1.0,
+  "sync_bytes_sent": 1.0,
+  "requests_get": 1.0,
+  "requests_put": 1.0,
+  "requests_other": 1.0,
+  "logged_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Site bandwidth ID
+* `bytes_received` (double): Site bandwidth report bytes received
+* `bytes_sent` (double): Site bandwidth report bytes sent
+* `sync_bytes_received` (double): Site sync bandwidth report bytes received
+* `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
+* `requests_get` (double): Site bandwidth report get requests
+* `requests_put` (double): Site bandwidth report put requests
+* `requests_other` (double): Site bandwidth report other requests
+* `logged_at` (date-time): Time the site bandwidth report was logged
+
+---
+
+## List Bandwidth Snapshots
+
+```
+await BandwidthSnapshot.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.

package/docs/models/Behavior.md

@@ -0,0 +1,195 @@
+# Behavior
+
+## Example Behavior Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "attachment_url": "",
+  "behavior": "webhook",
+  "name": "",
+  "description": "",
+  "value": {
+    "method": "GET"
+  }
+}
+```
+
+* `id` (int64): Folder behavior ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `attachment_url` (string): URL for attached file
+* `behavior` (string): Behavior type.
+* `name` (string): Name for this behavior.
+* `description` (string): Description for this behavior.
+* `value` (object): Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `attachment_delete` (boolean): If true, will delete the file stored in attachment
+
+---
+
+## List Behaviors
+
+```
+await Behavior.list({
+  'per_page': 1,
+  'behavior': "webhook",
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
+* `behavior` (string): If set, only shows folder behaviors matching this behavior type.
+
+---
+
+## Show Behavior
+
+```
+await Behavior.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+
+---
+
+## List Behaviors by path
+
+```
+await Behavior.listFor(path, {
+  'per_page': 1,
+  'behavior': "webhook",
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
+* `path` (string): Required - Path to operate on.
+* `recursive` (string): Show behaviors above this path?
+* `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
+
+---
+
+## Create Behavior
+
+```
+await Behavior.create({
+  'value': "{\"method\": \"GET\"}",
+  'path': "path",
+  'behavior': "webhook",
+})
+```
+
+
+### Parameters
+
+* `value` (string): The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `name` (string): Name for this behavior.
+* `description` (string): Description for this behavior.
+* `path` (string): Required - Folder behaviors path.
+* `behavior` (string): Required - Behavior type.
+
+---
+
+## Test webhook
+
+```
+await Behavior.webhookTest({
+  'url': "https://www.site.com/...",
+  'method': "GET",
+  'encoding': "RAW",
+  'headers': "x-test-header => testvalue",
+  'body': "test-param => testvalue",
+  'action': "test",
+})
+```
+
+
+### Parameters
+
+* `url` (string): Required - URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body
+
+---
+
+## Update Behavior
+
+```
+const [behavior] = await Behavior.list()
+
+await behavior.update({
+  'value': "{\"method\": \"GET\"}",
+  'behavior': "webhook",
+  'attachment_delete': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+* `value` (string): The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `name` (string): Name for this behavior.
+* `description` (string): Description for this behavior.
+* `behavior` (string): Behavior type.
+* `path` (string): Folder behaviors path.
+* `attachment_delete` (boolean): If true, will delete the file stored in attachment
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "path": "",
+  "attachment_url": "",
+  "behavior": "webhook",
+  "name": "",
+  "description": "",
+  "value": {
+    "method": "GET"
+  }
+}
+```
+
+---
+
+## Delete Behavior
+
+```
+const [behavior] = await Behavior.list()
+
+await behavior.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+