files.com 1.0.127 → 1.0.128

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15dbc7abb6293b77a82d25bf3f994067c822ef00bee620936112530f03d621b2
-  data.tar.gz: 91ed6680ef400cfc4b9cd835b2683ea3491c46bddf8d0344c132f712d461f96a
+  metadata.gz: d3e1278f84e7c16dba288784cf89e9a52b4dbb2d864c8dccce564ea413aad735
+  data.tar.gz: 06d50e38f5728b443c19f104f63545b5ee414fe85805dbe09f77628c82b0881b
 SHA512:
-  metadata.gz: 34da33211bf14a73e5e4e7d8cf4cd61881cd84270285c6396fa2822e1c5dbf3ad3438393affc2bff59a6664a5638e924d46a794033849cae4b8ca3c7bc986638
-  data.tar.gz: 1d69ae3c02058e92fb3deed3ab1f44fde463d80afaba73b6e59411f1bef18e441f7811ecc9025fa1cb21a4709e148b073526f083d6824bc71dfe532cc412db04
+  metadata.gz: 96ceaa8549312e55ff63dba0d16d0498ab99833505279684d3e7ec36cadb3d9866dcc5d34e23af4029c87336bef658fd2468e2116f0bf975eb61654eeb90eb7c
+  data.tar.gz: d24ed0fb7d3cddd8d71ed270649294e4b2b543f8b6f4f8a3fb062538ed27463e2c361534d47d958b97b314721ba202d7f8d41cf3989ae04cb07a3f2c314337a9

data/_VERSION

@@ -1 +1 @@
-1.0.127
+1.0.128

data/docs/account_line_item.md

@@ -11,11 +11,27 @@
   "currency": "USD",
   "download_uri": "https://url...",
   "invoice_line_items": [
-
+    {
+      "amount": 1.0,
+      "created_at": "2000-01-01T01:00:00Z",
+      "description": "Service from 2019-01-01 through 2019-12-31",
+      "type": "invoice",
+      "service_end_at": "2000-01-01T01:00:00Z",
+      "service_start_at": "2000-01-01T01:00:00Z",
+      "updated_at": "2000-01-01T01:00:00Z",
+      "plan": "Enterprise",
+      "site": "My site"
+    }
   ],
   "method": "paypal",
   "payment_line_items": [
-
+    {
+      "amount": 1.0,
+      "created_at": "2000-01-01T01:00:00Z",
+      "invoice_id": 1,
+      "payment_id": 1,
+      "updated_at": "2000-01-01T01:00:00Z"
+    }
   ],
   "payment_reversed_at": "2000-01-01T01:00:00Z",
   "payment_type": "",

data/docs/api_key.md

@@ -47,7 +47,7 @@ Files::ApiKey.list(
 * `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 the X-Files-Cursor-Next 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 `deleted_at` and `expires_at`.
+* `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 `expires_at`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `expires_at`.

data/docs/app.md

@@ -9,7 +9,9 @@
   "documentation_links": "Important Info => http://files.test/learn-more",
   "icon_url": "",
   "logo_url": "",
-  "screenshot_list_urls": "",
+  "screenshot_list_urls": [
+    ""
+  ],
   "logo_thumbnail_url": "",
   "sso_strategy_type": "",
   "remote_server_type": "",

data/docs/automation.md

@@ -28,11 +28,14 @@
   "path": "",
   "user_id": 1,
   "user_ids": [
-
+    1,
+    2
   ],
   "group_ids": [
-
-  ]
+    1,
+    2
+  ],
+  "webhook_url": "https://app.files.com/api/webhooks/abc123"
 }
 ```
 
@@ -50,6 +53,7 @@
 * `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.
 
 
 ---
@@ -67,7 +71,7 @@ Files::Automation.list(
 
 * `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 the X-Files-Cursor-Next 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 `site_id` and `automation`.
+* `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`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
@@ -100,6 +104,8 @@ Files::Automation.create(
   source: "source", 
   destination: "destination", 
   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)\"}", 
   trigger: "realtime"
 )
@@ -130,6 +136,8 @@ Files::Automation.update(id,
   source: "source", 
   destination: "destination", 
   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)\"}", 
   trigger: "realtime"
 )
@@ -176,6 +184,8 @@ automation.update(
   source: "source",
   destination: "destination",
   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)\"}",
   trigger: "realtime"
 )

data/docs/bandwidth_snapshot.md

@@ -7,6 +7,8 @@
   "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,
@@ -19,6 +21,8 @@
 * `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
@@ -41,7 +45,7 @@ Files::BandwidthSnapshot.list(
 
 * `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 the X-Files-Cursor-Next 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 `site_id` and `logged_at`.
+* `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 specifiied field is equal to the supplied value. Valid fields are `logged_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.

data/docs/behavior.md

@@ -37,7 +37,7 @@ Files::Behavior.list(
 
 * `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 the X-Files-Cursor-Next 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 `site_id` and `behavior`.
+* `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 specifiied field is equal to the supplied value. Valid fields are `behavior`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -75,7 +75,7 @@ Files::Behavior.list_for(path,
 
 * `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 the X-Files-Cursor-Next 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 `site_id` and `behavior`.
+* `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 specifiied field is equal to the supplied value. Valid fields are `behavior`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.

data/docs/bundle.md

@@ -11,6 +11,32 @@
   "require_registration": true,
   "require_share_recipient": true,
   "clickwrap_body": "[Legal text]",
+  "form_field_set": {
+    "id": 1,
+    "title": "Sample Form Title",
+    "form_layout": [
+      1,
+      2,
+      3,
+      4
+    ],
+    "form_fields": [
+      {
+        "id": 1,
+        "label": "Sample Label",
+        "required": true,
+        "help_text": "Help Text",
+        "field_type": "text",
+        "options_for_select": [
+          "red",
+          "green",
+          "blue"
+        ],
+        "default_option": "red",
+        "form_field_set_id": 1
+      }
+    ]
+  },
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
@@ -22,7 +48,7 @@
   "inbox_id": 1,
   "has_inbox": true,
   "paths": [
-
+    "file.txt"
   ]
 }
 ```
@@ -34,6 +60,7 @@
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
 * `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
+* `form_field_set`: Custom Form to use
 * `id` (int64): Bundle ID
 * `created_at` (date-time): Bundle created at date/time
 * `expires_at` (date-time): Bundle expiration date/time
@@ -46,6 +73,7 @@
 * `has_inbox` (boolean): Does this bundle have an associated inbox?
 * `paths` (array): A list of paths in this bundle
 * `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 
 
 ---
@@ -64,7 +92,7 @@ Files::Bundle.list(
 * `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 the X-Files-Cursor-Next 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 `site_id`, `created_at` or `code`.
+* `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 `code`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
@@ -95,6 +123,7 @@ Files::Bundle.create(
   user_id: 1, 
   paths: ["file.txt"], 
   password: "Password", 
+  form_field_set_id: 1, 
   expires_at: "2000-01-01T01:00:00Z", 
   max_uses: 1, 
   description: "The public description of the bundle.", 
@@ -112,6 +141,7 @@ Files::Bundle.create(
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `expires_at` (string): Bundle expiration date/time
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
@@ -151,6 +181,7 @@ Files::Bundle.share(id,
 Files::Bundle.update(id, 
   paths: ["file.txt"], 
   password: "Password", 
+  form_field_set_id: 1, 
   clickwrap_id: 1, 
   code: "abc123", 
   description: "The public description of the bundle.", 
@@ -168,6 +199,7 @@ Files::Bundle.update(id,
 * `id` (int64): Required - Bundle ID.
 * `paths` (array(string)): A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `description` (string): Public description
@@ -224,6 +256,7 @@ bundle = Files::Bundle.list_for(path).first
 bundle.update(
   paths: ["file.txt"],
   password: "Password",
+  form_field_set_id: 1,
   clickwrap_id: 1,
   code: "abc123",
   description: "The public description of the bundle.",
@@ -241,6 +274,7 @@ bundle.update(
 * `id` (int64): Required - Bundle ID.
 * `paths` (array(string)): A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `description` (string): Public description

data/docs/bundle_download.md

@@ -4,12 +4,14 @@
 
 ```
 {
+  "bundle_registration": "",
   "download_method": "file",
   "path": "a/b/test.txt",
   "created_at": "2020-01-01 00:00:00"
 }
 ```
 
+* `bundle_registration`: 
 * `download_method` (string): Download method (file or full_zip)
 * `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `created_at` (date-time): Download date/time
@@ -22,6 +24,7 @@
 ```
 Files::BundleDownload.list(
   per_page: 1, 
+  bundle_id: 1, 
   bundle_registration_id: 1
 )
 ```
@@ -30,4 +33,5 @@ Files::BundleDownload.list(
 
 * `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 the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `bundle_registration_id` (int64): Required - BundleRegistration ID
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): BundleRegistration ID

data/docs/bundle_recipient.md

@@ -36,4 +36,11 @@ Files::BundleRecipient.list(
 * `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 the X-Files-Cursor-Next 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 `has_registrations`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
 * `bundle_id` (int64): Required - List recipients for the bundle with this ID.

data/docs/bundle_registration.md

@@ -0,0 +1,23 @@
+# BundleRegistration
+
+## Example BundleRegistration Object
+
+```
+{
+  "code": "abc123",
+  "name": "account",
+  "company": "Action Verb",
+  "email": "john.doe@files.com",
+  "inbox_code": "abc123",
+  "form_field_set_id": 1,
+  "form_field_data": ""
+}
+```
+
+* `code` (string): Registration cookie code
+* `name` (string): Registrant name
+* `company` (string): Registrant company name
+* `email` (string): Registrant email address
+* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
+* `form_field_set_id` (int64): Id of associated form field set
+* `form_field_data` (string): Data for form field set with form field ids as keys and user data as values

data/docs/external_event.md

@@ -31,7 +31,7 @@ Files::ExternalEvent.list(
 
 * `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 the X-Files-Cursor-Next 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 `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
+* `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 `remote_server_type`, `event_type`, `created_at` or `status`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.

data/docs/file.md

@@ -22,7 +22,13 @@ may places where a Ruby File object can be used.
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": ""
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "complete",
+    "size": 1024
+  }
 }
 ```
 

data/docs/file_action.md

@@ -1,3 +1,16 @@
+# FileAction
+
+## Example FileAction Object
+
+```
+{
+  "status": "enqueued",
+  "file_migration_id": "123"
+}
+```
+
+* `status` (string): Status of file operation. Possible values: completed, enqueued.
+* `file_migration_id` (int64): If status is enqueued, this is the id of the FileMigration to check for status updates.
 
 
 ---

data/docs/file_comment.md

@@ -7,7 +7,10 @@
   "id": 1,
   "body": "What a great file!",
   "reactions": [
-
+    {
+      "id": 1,
+      "emoji": "👍"
+    }
   ]
 }
 ```

data/docs/folder.md

@@ -24,7 +24,13 @@ Files::Dir is an alias of Files::Folder
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": ""
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "complete",
+    "size": 1024
+  }
 }
 ```
 

data/docs/form_field.md

@@ -0,0 +1,29 @@
+# FormField
+
+## Example FormField Object
+
+```
+{
+  "id": 1,
+  "label": "Sample Label",
+  "required": true,
+  "help_text": "Help Text",
+  "field_type": "text",
+  "options_for_select": [
+    "red",
+    "green",
+    "blue"
+  ],
+  "default_option": "red",
+  "form_field_set_id": 1
+}
+```
+
+* `id` (int64): Form field id
+* `label` (string): Label to be displayed
+* `required` (boolean): Is this a required field?
+* `help_text` (string): Help text to be displayed
+* `field_type` (string): Type of Field
+* `options_for_select` (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