files.com 1.0.190 → 1.0.193

package/docs/models/HistoryExport.md

@@ -0,0 +1,130 @@
+# HistoryExport
+
+## Example HistoryExport Object
+
+```
+{
+  "id": 1,
+  "history_version": "20201213.2",
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "status": "ready",
+  "query_action": "read",
+  "query_interface": "ftp",
+  "query_user_id": "1",
+  "query_file_id": "1",
+  "query_parent_id": "1",
+  "query_path": "MyFile.txt",
+  "query_folder": "Folder",
+  "query_src": "SrcFolder",
+  "query_destination": "DestFolder",
+  "query_ip": "127.0.0.1",
+  "query_username": "jerry",
+  "query_failure_type": "bad_password",
+  "query_target_id": "1",
+  "query_target_name": "full",
+  "query_target_permission": "full",
+  "query_target_user_id": "1",
+  "query_target_username": "jerry",
+  "query_target_platform": "windows",
+  "query_target_permission_set": "desktop_app",
+  "results_url": "https://files.com/history_results.csv"
+}
+```
+
+* `id` (int64): History Export ID
+* `history_version` (string): Version of the history for the export.
+* `start_at` (date-time): Start date/time of export range.
+* `end_at` (date-time): End date/time of export range.
+* `status` (string): Status of export.  Will be: `building`, `ready`, or `failed`
+* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
+* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
+* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
+* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
+* `query_path` (string): Return results that are file actions related to this path.
+* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
+* `query_src` (string): Return results that are file moves originating from this path.
+* `query_destination` (string): Return results that are file moves with this path as destination.
+* `query_ip` (string): Filter results by this IP address.
+* `query_username` (string): Filter results by this username.
+* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
+* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
+* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
+* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
+* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
+* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
+* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
+* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
+* `results_url` (string): If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+---
+
+## Show History Export
+
+```
+await HistoryExport.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - History Export ID.
+
+---
+
+## Create History Export
+
+```
+await HistoryExport.create({
+  'user_id': 1,
+  'start_at': "2000-01-01T01:00:00Z",
+  'end_at': "2000-01-01T01:00:00Z",
+  'query_action': "read",
+  'query_interface': "ftp",
+  'query_user_id': "1",
+  'query_file_id': "1",
+  'query_parent_id': "1",
+  'query_path': "MyFile.txt",
+  'query_folder': "Folder",
+  'query_src': "SrcFolder",
+  'query_destination': "DestFolder",
+  'query_ip': "127.0.0.1",
+  'query_username': "jerry",
+  'query_failure_type': "bad_password",
+  'query_target_id': "1",
+  'query_target_name': "full",
+  'query_target_permission': "full",
+  'query_target_user_id': "1",
+  'query_target_username': "jerry",
+  'query_target_platform': "windows",
+  'query_target_permission_set': "desktop_app",
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `start_at` (string): Start date/time of export range.
+* `end_at` (string): End date/time of export range.
+* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
+* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
+* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
+* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
+* `query_path` (string): Return results that are file actions related to this path.
+* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
+* `query_src` (string): Return results that are file moves originating from this path.
+* `query_destination` (string): Return results that are file moves with this path as destination.
+* `query_ip` (string): Filter results by this IP address.
+* `query_username` (string): Filter results by this username.
+* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
+* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
+* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
+* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
+* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
+* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
+* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
+* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

package/docs/models/HistoryExportResult.md

@@ -0,0 +1,75 @@
+# HistoryExportResult
+
+## Example HistoryExportResult Object
+
+```
+{
+  "id": 1,
+  "created_at": 1,
+  "user_id": 1,
+  "file_id": 1,
+  "parent_id": 1,
+  "path": "MyFile.txt",
+  "folder": "Folder",
+  "src": "SrcFolder",
+  "destination": "DestFolder",
+  "ip": "127.0.0.1",
+  "username": "jerry",
+  "action": "read",
+  "failure_type": "bad_password",
+  "interface": "ftp",
+  "target_id": 1,
+  "target_name": "full",
+  "target_permission": "full",
+  "target_recursive": true,
+  "target_expires_at": 1,
+  "target_permission_set": "desktop_app",
+  "target_platform": "windows",
+  "target_username": "jerry",
+  "target_user_id": 1
+}
+```
+
+* `id` (int64): Action ID
+* `created_at` (int64): When the action happened
+* `user_id` (int64): User ID
+* `file_id` (int64): File ID related to the action
+* `parent_id` (int64): ID of the parent folder
+* `path` (string): Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `folder` (string): Folder in which the action occurred
+* `src` (string): File move originated from this path
+* `destination` (string): File moved to this destination folder
+* `ip` (string): Client IP that performed the action
+* `username` (string): Username of the user that performed the action
+* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `failure_type` (string): The type of login failure, if applicable.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
+* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
+* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
+* `target_name` (string): Name of the User, Group or other object with a name related to this action
+* `target_permission` (string): Permission level of the action
+* `target_recursive` (boolean): Whether or not the action was recursive
+* `target_expires_at` (int64): If searching for Histories about API keys, this is when the API key will expire
+* `target_permission_set` (string): If searching for Histories about API keys, this represents the permission set of the associated  API key
+* `target_platform` (string): If searching for Histories about API keys, this is the platform on which the action was taken
+* `target_username` (string): If searching for Histories about API keys, this is the username on which the action was taken
+* `target_user_id` (int64): If searching for Histories about API keys, this is the User ID on which the action was taken
+
+---
+
+## List History Export Results
+
+```
+await HistoryExportResult.list({
+  'user_id': 1,
+  'per_page': 1,
+  'history_export_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).
+* `history_export_id` (int64): Required - ID of the associated history export.

package/docs/models/Image.md

@@ -0,0 +1,13 @@
+# Image
+
+## Example Image Object
+
+```
+{
+  "name": "My logo",
+  "uri": "https://mysite.files.com/.../my_image.png"
+}
+```
+
+* `name` (string): Image name
+* `uri` (string): Image URI

package/docs/models/InboxRecipient.md

@@ -0,0 +1,76 @@
+# InboxRecipient
+
+## Example InboxRecipient Object
+
+```
+{
+  "company": "Acme Inc.",
+  "name": "John Doe",
+  "note": "Some note.",
+  "recipient": "john.doe@example.com",
+  "sent_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `company` (string): The recipient's company.
+* `name` (string): The recipient's name.
+* `note` (string): A note sent to the recipient with the inbox.
+* `recipient` (string): The recipient's email address.
+* `sent_at` (date-time): When the Inbox was shared with this recipient.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `inbox_id` (int64): Inbox to share.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
+
+---
+
+## List Inbox Recipients
+
+```
+await InboxRecipient.list({
+  'user_id': 1,
+  'per_page': 1,
+  'inbox_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 `has_registrations`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
+
+---
+
+## Create Inbox Recipient
+
+```
+await InboxRecipient.create({
+  'user_id': 1,
+  'inbox_id': 1,
+  'recipient': "johndoe@gmail.com",
+  'name': "John Smith",
+  'company': "Acme Ltd",
+  'note': "Just a note.",
+  'share_after_create': true,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `inbox_id` (int64): Required - Inbox to share.
+* `recipient` (string): Required - Email address to share this inbox with.
+* `name` (string): Name of recipient.
+* `company` (string): Company of recipient.
+* `note` (string): Note to include in email.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.

package/docs/models/InboxRegistration.md

@@ -0,0 +1,47 @@
+# InboxRegistration
+
+## Example InboxRegistration Object
+
+```
+{
+  "code": "abc123",
+  "name": "account",
+  "company": "Action Verb",
+  "email": "john.doe@files.com",
+  "clickwrap_body": "",
+  "form_field_set_id": 1,
+  "form_field_data": "",
+  "inbox_id": 1,
+  "inbox_recipient_id": 1,
+  "inbox_title": ""
+}
+```
+
+* `code` (string): Registration cookie code
+* `name` (string): Registrant name
+* `company` (string): Registrant company name
+* `email` (string): Registrant email address
+* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
+* `form_field_set_id` (int64): Id of associated form field set
+* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
+* `inbox_id` (int64): Id of associated inbox
+* `inbox_recipient_id` (int64): Id of associated inbox recipient
+* `inbox_title` (string): Title of associated inbox
+
+---
+
+## List Inbox Registrations
+
+```
+await InboxRegistration.list({
+  'per_page': 1,
+  'folder_behavior_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 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).
+* `folder_behavior_id` (int64): ID of the associated Inbox.

package/docs/models/InboxUpload.md

@@ -0,0 +1,42 @@
+# InboxUpload
+
+## Example InboxUpload Object
+
+```
+{
+  "inbox_registration": "",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `inbox_registration` (InboxRegistration): 
+* `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
+
+```
+await 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 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`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
+* `inbox_registration_id` (int64): InboxRegistration ID
+* `inbox_id` (int64): Inbox ID

package/docs/models/Invoice.md

@@ -0,0 +1,82 @@
+# Invoice
+
+## Example Invoice Object
+
+```
+{
+  "id": 1,
+  "amount": 1.0,
+  "balance": 1.0,
+  "created_at": "2000-01-01T01:00:00Z",
+  "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": "",
+  "site_name": "My Site",
+  "type": "invoice",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Line item Id
+* `amount` (double): Line item amount
+* `balance` (double): Line item balance
+* `created_at` (date-time): Line item created at
+* `currency` (string): Line item currency
+* `download_uri` (string): Line item download uri
+* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
+* `method` (string): Line item payment method
+* `payment_line_items` (PaymentLineItem): 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
+* `type` (string): Type of line item, either payment or invoice
+* `updated_at` (date-time): Line item updated at
+
+---
+
+## List Invoices
+
+```
+await Invoice.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).
+
+---
+
+## Show Invoice
+
+```
+await Invoice.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Invoice ID.

package/docs/models/InvoiceLineItem.md

@@ -0,0 +1,27 @@
+# InvoiceLineItem
+
+## Example InvoiceLineItem Object
+
+```
+{
+  "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"
+}
+```
+
+* `amount` (double): Invoice line item amount
+* `created_at` (date-time): Invoice line item created at date/time
+* `description` (string): Invoice line item description
+* `type` (string): Invoice line item type
+* `service_end_at` (date-time): Invoice line item service end date/time
+* `service_start_at` (date-time): Invoice line item service start date/time
+* `updated_at` (date-time): Invoice line item updated date/time
+* `plan` (string): Plan name
+* `site` (string): Site name

package/docs/models/IpAddress.md

@@ -0,0 +1,51 @@
+# IpAddress
+
+## Example IpAddress Object
+
+```
+{
+  "id": "Site",
+  "associated_with": "Site",
+  "group_id": 1,
+  "ip_addresses": [
+    "127.0.0.1"
+  ]
+}
+```
+
+* `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.
+
+---
+
+## List IP Addresses associated with the current site
+
+```
+await IpAddress.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).
+
+---
+
+## List all possible public IP addresses
+
+```
+await IpAddress.getReserved({
+  '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).

package/docs/models/Lock.md

@@ -0,0 +1,92 @@
+# Lock
+
+## Example Lock Object
+
+```
+{
+  "path": "locked_file",
+  "timeout": 43200,
+  "depth": "infinity",
+  "recursive": true,
+  "owner": "user",
+  "scope": "shared",
+  "exclusive": true,
+  "token": "17c54824e9931a4688ca032d03f6663c",
+  "type": "write",
+  "allow_access_by_any_user": true,
+  "user_id": 1,
+  "username": ""
+}
+```
+
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `timeout` (int64): Lock timeout in seconds
+* `depth` (string): DEPRECATED: Lock depth
+* `recursive` (boolean): Does lock apply to subfolders?
+* `owner` (string): Owner of the lock.  This can be any arbitrary string.
+* `scope` (string): DEPRECATED: Lock scope
+* `exclusive` (boolean): Is lock exclusive?
+* `token` (string): Lock token.  Use to release lock.
+* `type` (string): DEPRECATED: Lock type
+* `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
+* `user_id` (int64): Lock creator user ID
+* `username` (string): Lock creator username
+
+---
+
+## List Locks by path
+
+```
+await Lock.listFor(path, {
+  'per_page': 1,
+  'include_children': true,
+})
+```
+
+
+### 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).
+* `path` (string): Required - Path to operate on.
+* `include_children` (boolean): Include locks from children objects?
+
+---
+
+## Create Lock
+
+```
+await Lock.create(path, {
+  'allow_access_by_any_user': true,
+  'exclusive': true,
+  'recursive': true,
+  'timeout': 1,
+})
+```
+
+
+### Parameters
+
+* `path` (string): Required - Path
+* `allow_access_by_any_user` (boolean): Allow lock to be updated by any user?
+* `exclusive` (boolean): Is lock exclusive?
+* `recursive` (string): Does lock apply to subfolders?
+* `timeout` (int64): Lock timeout length
+
+---
+
+## Delete Lock
+
+```
+const [lock] = await Lock.list()
+
+await lock.delete({
+  'token': "token",
+})
+```
+
+### Parameters
+
+* `path` (string): Required - Path
+* `token` (string): Required - Lock token
+