files.com 1.0.123 → 1.0.128

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

data/docs/form_field_set.md

@@ -0,0 +1,154 @@
+# FormFieldSet
+
+## Example FormFieldSet Object
+
+```
+{
+  "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` (int64): Form field set id
+* `title` (string): Title to be displayed
+* `form_layout` (int64): Layout of the form
+* `form_fields` (array): Associated form fields
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
+---
+
+## List Form Field Sets
+
+```
+Files::FormFieldSet.list(
+  user_id: 1, 
+  per_page: 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 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).
+
+
+---
+
+## Show Form Field Set
+
+```
+Files::FormFieldSet.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+
+
+---
+
+## Create Form Field Set
+
+```
+Files::FormFieldSet.create(
+  user_id: 1, 
+  title: "Sample Form Title", 
+  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}]
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `title` (string): Title to be displayed
+* `form_fields` (array(object)): 
+
+
+---
+
+## Update Form Field Set
+
+```
+Files::FormFieldSet.update(id, 
+  title: "Sample Form Title", 
+  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}]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+* `title` (string): Title to be displayed
+* `form_fields` (array(object)): 
+
+
+---
+
+## Delete Form Field Set
+
+```
+Files::FormFieldSet.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+
+
+---
+
+## Update Form Field Set
+
+```
+form_field_set = Files::FormFieldSet.list_for(path).first
+
+form_field_set.update(
+  title: "Sample Form Title",
+  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}]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+* `title` (string): Title to be displayed
+* `form_fields` (array(object)): 
+
+
+---
+
+## Delete Form Field Set
+
+```
+form_field_set = Files::FormFieldSet.list_for(path).first
+
+form_field_set.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.

data/docs/group.md

@@ -7,14 +7,14 @@
   "id": 1,
   "name": "owners",
   "admin_ids": [
-
+    1
   ],
   "notes": "",
   "user_ids": [
-
+    1
   ],
   "usernames": [
-
+    "user"
   ]
 }
 ```
@@ -41,7 +41,7 @@ Files::Group.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 `active`, `site_id` or `name`.
+* `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 `name`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.
@@ -70,7 +70,9 @@ Files::Group.find(id)
 
 ```
 Files::Group.create(
-  name: "owners"
+  name: "owners", 
+  user_ids: [1], 
+  admin_ids: [1]
 )
 ```
 
@@ -88,7 +90,9 @@ Files::Group.create(
 
 ```
 Files::Group.update(id, 
-  name: "owners"
+  name: "owners", 
+  user_ids: [1], 
+  admin_ids: [1]
 )
 ```
 
@@ -122,7 +126,9 @@ Files::Group.delete(id)
 group = Files::Group.list_for(path).first
 
 group.update(
-  name: "owners"
+  name: "owners",
+  user_ids: [1],
+  admin_ids: [1]
 )
 ```
 

data/docs/group_user.md

@@ -9,7 +9,7 @@
   "user_id": 1,
   "admin": true,
   "usernames": [
-
+    "user"
   ]
 }
 ```

data/docs/history.md

@@ -142,7 +142,7 @@ Files::History.list(
 * `display` (string): Display format. Leave blank or set to `full` or `parent`.
 * `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`, `path`, `created_at`, `folder` or `user_id`.
+* `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 `path`, `folder`, `user_id` or `created_at`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
 * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.

data/docs/inbox_registration.md

@@ -0,0 +1,21 @@
+# InboxRegistration
+
+## Example InboxRegistration Object
+
+```
+{
+  "code": "abc123",
+  "name": "account",
+  "company": "Action Verb",
+  "email": "john.doe@files.com",
+  "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
+* `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/inbox_upload.md

@@ -0,0 +1,35 @@
+# InboxUpload
+
+## Example InboxUpload Object
+
+```
+{
+  "inbox_registration": "",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `inbox_registration`: 
+* `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `created_at` (date-time): Upload date/time
+
+
+---
+
+## List Inbox Uploads
+
+```
+Files::InboxUpload.list(
+  per_page: 1, 
+  inbox_registration_id: 1, 
+  inbox_id: 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 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).
+* `inbox_registration_id` (int64): InboxRegistration ID
+* `inbox_id` (int64): Inbox ID

data/docs/invoice.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/ip_address.md

@@ -8,7 +8,7 @@
   "associated_with": "Site",
   "group_id": 1,
   "ip_addresses": [
-
+    "127.0.0.1"
   ]
 }
 ```

data/docs/message.md

@@ -8,7 +8,16 @@
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
   "comments": [
-
+    {
+      "id": 1,
+      "body": "What a great idea, thank you!",
+      "reactions": [
+        {
+          "id": 1,
+          "emoji": "👍"
+        }
+      ]
+    }
   ]
 }
 ```