files.com 1.0.190 → 1.0.193

package/docs/models/Folder.md

@@ -0,0 +1,90 @@
+# Folder
+
+## Example Folder Object
+
+```
+{
+  "path": "path/file.txt",
+  "display_name": "file.txt",
+  "type": "file",
+  "size": 1024,
+  "mtime": "2000-01-01T01:00:00Z",
+  "provided_mtime": "2000-01-01T01:00:00Z",
+  "crc32": "70976923",
+  "md5": "17c54824e9931a4688ca032d03f6663c",
+  "mime_type": "application/octet-stream",
+  "region": "us-east-1",
+  "permissions": "rwd",
+  "subfolders_locked?": true,
+  "download_uri": "https://mysite.files.com/...",
+  "priority_color": "red",
+  "preview_id": 1,
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "image",
+    "size": "large"
+  }
+}
+```
+
+* `path` (string): File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `display_name` (string): File/Folder display name
+* `type` (string): Type: `directory` or `file`.
+* `size` (int64): File/Folder size
+* `mtime` (date-time): File last modified date/time, according to the server.  This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
+* `provided_mtime` (date-time): File last modified date/time, according to the client who set it.  Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times.  This allows Desktop<->Cloud syncing to preserve modified at times.
+* `crc32` (string): File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
+* `md5` (string): File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
+* `mime_type` (string): MIME Type.  This is determined by the filename extension and is not stored separately internally.
+* `region` (string): Region location
+* `permissions` (string): A short string representing the current user's permissions.  Can be `r`,`w`,`d`, `l` or any combination
+* `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
+* `download_uri` (string): Link to download file. Provided only in response to a download request.
+* `priority_color` (string): Bookmark/priority color of file/folder
+* `preview_id` (int64): File preview ID
+* `preview` (Preview): File preview
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?
+
+---
+
+## List Folders by path
+
+```
+await Folder.listFor(path, {
+  'per_page': 1,
+  'search_all': true,
+  'with_previews': true,
+  'with_priority_color': true,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Send cursor 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 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).
+* `path` (string): Required - Path to operate on.
+* `filter` (string): If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+* `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+* `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
+* `search_all` (boolean): Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the UI.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+* `with_previews` (boolean): Include file previews?
+* `with_priority_color` (boolean): Include file priority color information?
+
+---
+
+## Create folder
+
+```
+await Folder.create(path, {
+  'mkdir_parents': true,
+})
+```
+
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?

package/docs/models/FormField.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

package/docs/models/FormFieldSet.md

@@ -0,0 +1,170 @@
+# 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
+  },
+  "skip_name": true,
+  "skip_email": true,
+  "skip_company": true
+}
+```
+
+* `id` (int64): Form field set id
+* `title` (string): Title to be displayed
+* `form_layout` (int64): Layout of the form
+* `form_fields` (FormField): 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
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+---
+
+## List Form Field Sets
+
+```
+await 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 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).
+
+---
+
+## Show Form Field Set
+
+```
+await FormFieldSet.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+
+---
+
+## Create Form Field Set
+
+```
+await FormFieldSet.create({
+  'user_id': 1,
+  'title': "Sample Form Title",
+  'skip_email': true,
+  'skip_name': true,
+  'skip_company': true,
+  'form_fields': {"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
+* `skip_email` (boolean): Skip validating form email
+* `skip_name` (boolean): Skip validating form name
+* `skip_company` (boolean): Skip validating company
+* `form_fields` (array(object)): 
+
+---
+
+## Update Form Field Set
+
+```
+const [form_field_set] = await FormFieldSet.list()
+
+await form_field_set.update({
+  'title': "Sample Form Title",
+  'skip_email': true,
+  'skip_name': true,
+  'skip_company': true,
+  '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
+* `skip_email` (boolean): Skip validating form email
+* `skip_name` (boolean): Skip validating form name
+* `skip_company` (boolean): Skip validating company
+* `form_fields` (array(object)): 
+
+### Example Response
+
+```json
+{
+  "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
+  },
+  "skip_name": true,
+  "skip_email": true,
+  "skip_company": true
+}
+```
+
+---
+
+## Delete Form Field Set
+
+```
+const [form_field_set] = await FormFieldSet.list()
+
+await form_field_set.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Form Field Set ID.
+

package/docs/models/Group.md

@@ -0,0 +1,140 @@
+# Group
+
+## Example Group Object
+
+```
+{
+  "id": 1,
+  "name": "owners",
+  "admin_ids": [
+    1
+  ],
+  "notes": "",
+  "user_ids": [
+    1
+  ],
+  "usernames": [
+    "user"
+  ]
+}
+```
+
+* `id` (int64): Group ID
+* `name` (string): Group name
+* `admin_ids` (string): List of user IDs who are group administrators (separated by commas)
+* `notes` (string): Notes about this group
+* `user_ids` (array): List of user IDs who belong to this group (separated by commas)
+* `usernames` (array): List of usernames who belong to this group (separated by commas)
+
+---
+
+## List Groups
+
+```
+await Group.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 `name`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
+* `ids` (string): Comma-separated list of group ids to include in results.
+
+---
+
+## Show Group
+
+```
+await Group.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+
+---
+
+## Create Group
+
+```
+await Group.create({
+  'name': "owners",
+  'user_ids': [1],
+  'admin_ids': [1],
+})
+```
+
+
+### Parameters
+
+* `name` (string): Group name.
+* `notes` (string): Group notes.
+* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
+* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+
+---
+
+## Update Group
+
+```
+const [group] = await Group.list()
+
+await group.update({
+  'name': "owners",
+  'user_ids': [1],
+  'admin_ids': [1],
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+* `name` (string): Group name.
+* `notes` (string): Group notes.
+* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
+* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "name": "owners",
+  "admin_ids": [
+    1
+  ],
+  "notes": "",
+  "user_ids": [
+    1
+  ],
+  "usernames": [
+    "user"
+  ]
+}
+```
+
+---
+
+## Delete Group
+
+```
+const [group] = await Group.list()
+
+await group.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+

package/docs/models/GroupUser.md

@@ -0,0 +1,116 @@
+# GroupUser
+
+## Example GroupUser Object
+
+```
+{
+  "group_name": "My Group",
+  "group_id": 1,
+  "user_id": 1,
+  "admin": true,
+  "usernames": [
+    "user"
+  ]
+}
+```
+
+* `group_name` (string): Group name
+* `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
+* `id` (int64): Group User ID.
+
+---
+
+## List Group Users
+
+```
+await GroupUser.list({
+  'user_id': 1,
+  'per_page': 1,
+  'group_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  If provided, will return group_users of this 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).
+* `group_id` (int64): Group ID.  If provided, will return group_users of this group.
+
+---
+
+## Create Group User
+
+```
+await GroupUser.create({
+  'group_id': 1,
+  'user_id': 1,
+  'admin': true,
+})
+```
+
+
+### Parameters
+
+* `group_id` (int64): Required - Group ID to add user to.
+* `user_id` (int64): Required - User ID to add to group.
+* `admin` (boolean): Is the user a group administrator?
+
+---
+
+## Update Group User
+
+```
+const [group_user] = await GroupUser.list()
+
+await group_user.update({
+  'group_id': 1,
+  'user_id': 1,
+  'admin': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID to add user to.
+* `user_id` (int64): Required - User ID to add to group.
+* `admin` (boolean): Is the user a group administrator?
+
+### Example Response
+
+```json
+{
+  "group_name": "My Group",
+  "group_id": 1,
+  "user_id": 1,
+  "admin": true,
+  "usernames": [
+    "user"
+  ]
+}
+```
+
+---
+
+## Delete Group User
+
+```
+const [group_user] = await GroupUser.list()
+
+await group_user.delete({
+  'group_id': 1,
+  'user_id': 1,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID from which to remove user.
+* `user_id` (int64): Required - User ID to remove from group.
+

package/docs/models/History.md

@@ -0,0 +1,151 @@
+# History
+
+## Example History Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "display": "Actual text of the action here.",
+  "ip": "192.283.128.182",
+  "source": "/from_path",
+  "targets": [
+
+  ],
+  "user_id": 1,
+  "username": "user",
+  "action": "create",
+  "failure_type": "none",
+  "interface": "web"
+}
+```
+
+* `id` (int64): Action ID
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this action, if applicable
+* `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
+* `user_id` (int64): User ID
+* `username` (string): Username
+* `action` (string): Type of action
+* `failure_type` (string): Failure type.  If action was a user login or session failure, why did it fail?
+* `interface` (string): Interface on which this action occurred.
+
+---
+
+## List history for specific file
+
+```
+await History.listForFile(path, {
+  'display': "Actual text of the action here.",
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `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 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 `user_id` and `created_at`.
+* `path` (string): Required - Path to operate on.
+
+---
+
+## List history for specific folder
+
+```
+await History.listForFolder(path, {
+  'display': "Actual text of the action here.",
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `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 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 `user_id` and `created_at`.
+* `path` (string): Required - Path to operate on.
+
+---
+
+## List history for specific user
+
+```
+await History.listForUser(user_id, {
+  'display': "Actual text of the action here.",
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `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 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 `user_id` and `created_at`.
+* `user_id` (int64): Required - User ID.
+
+---
+
+## List site login history
+
+```
+await History.listLogins({
+  'display': "Actual text of the action here.",
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `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 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 `user_id` and `created_at`.
+
+---
+
+## List site full action history
+
+```
+await History.list({
+  'display': "Actual text of the action here.",
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `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 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 `path`, `folder`, `user_id` or `created_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.