files.com 1.0.190 → 1.0.193

package/docs/models/Payment.md

@@ -0,0 +1,82 @@
+# Payment
+
+## Example Payment 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 Payments
+
+```
+await Payment.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 Payment
+
+```
+await Payment.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Payment ID.

package/docs/models/PaymentLineItem.md

@@ -0,0 +1,19 @@
+# PaymentLineItem
+
+## Example PaymentLineItem Object
+
+```
+{
+  "amount": 1.0,
+  "created_at": "2000-01-01T01:00:00Z",
+  "invoice_id": 1,
+  "payment_id": 1,
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `amount` (double): Payment line item amount
+* `created_at` (date-time): Payment line item created at date/time
+* `invoice_id` (int64): Invoice ID
+* `payment_id` (int64): Payment ID
+* `updated_at` (date-time): Payment line item updated at date/time

package/docs/models/Permission.md

@@ -0,0 +1,94 @@
+# Permission
+
+## Example Permission Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "user_id": 1,
+  "username": "Sser",
+  "group_id": 1,
+  "group_name": "",
+  "permission": "full",
+  "recursive": true
+}
+```
+
+* `id` (int64): Permission ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `user_id` (int64): User ID
+* `username` (string): User's username
+* `group_id` (int64): Group ID
+* `group_name` (string): Group name if applicable
+* `permission` (string): Permission type
+* `recursive` (boolean): Does this permission apply to subfolders?
+
+---
+
+## List Permissions
+
+```
+await Permission.list({
+  'per_page': 1,
+  'group_id': 1,
+  'user_id': 1,
+  'include_groups': 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).
+* `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 `group_id`, `path`, `user_id` or `permission`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
+* `path` (string): DEPRECATED: Permission path.  If provided, will scope permissions to this path. Use `filter[path]` instead.
+* `group_id` (string): DEPRECATED: Group ID.  If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
+* `user_id` (string): DEPRECATED: User ID.  If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
+* `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
+
+---
+
+## Create Permission
+
+```
+await Permission.create({
+  'group_id': 1,
+  'permission': "full",
+  'recursive': true,
+  'user_id': 1,
+  'username': "Sser",
+})
+```
+
+
+### Parameters
+
+* `group_id` (int64): Group ID
+* `path` (string): Folder path
+* `permission` (string):  Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
+* `recursive` (boolean): Apply to subfolders recursively?
+* `user_id` (int64): User ID.  Provide `username` or `user_id`
+* `username` (string): User username.  Provide `username` or `user_id`
+
+---
+
+## Delete Permission
+
+```
+const [permission] = await Permission.list()
+
+await permission.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Permission ID.
+

package/docs/models/Preview.md

@@ -0,0 +1,19 @@
+# Preview
+
+## Example Preview Object
+
+```
+{
+  "id": 1,
+  "status": "complete",
+  "download_uri": "https://mysite.files.com/...",
+  "type": "image",
+  "size": "large"
+}
+```
+
+* `id` (int64): Preview ID
+* `status` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
+* `download_uri` (string): Link to download preview
+* `type` (string): Preview type. Can be image, pdf, pdf_native, video, or audio
+* `size` (string): Preview size

package/docs/models/Priority.md

@@ -0,0 +1,30 @@
+# Priority
+
+## Example Priority Object
+
+```
+{
+  "path": "foo/bar",
+  "color": "pink"
+}
+```
+
+* `path` (string): The path corresponding to the priority color This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `color` (string): The priority color
+
+---
+
+## List Priorities
+
+```
+await Priority.list(path, {
+  '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).
+* `path` (string): Required - The path to query for priorities

package/docs/models/Project.md

@@ -0,0 +1,98 @@
+# Project
+
+## Example Project Object
+
+```
+{
+  "id": 1,
+  "global_access": "none"
+}
+```
+
+* `id` (int64): Project ID
+* `global_access` (string): Global access settings
+
+---
+
+## List Projects
+
+```
+await Project.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 Project
+
+```
+await Project.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+
+---
+
+## Create Project
+
+```
+await Project.create({
+  'global_access': "global_access",
+})
+```
+
+
+### Parameters
+
+* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.
+
+---
+
+## Update Project
+
+```
+const [project] = await Project.list()
+
+await project.update({
+  'global_access': "global_access",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "global_access": "none"
+}
+```
+
+---
+
+## Delete Project
+
+```
+const [project] = await Project.list()
+
+await project.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+

package/docs/models/PublicIpAddress.md

@@ -0,0 +1,17 @@
+# PublicIpAddress
+
+## Example PublicIpAddress Object
+
+```
+{
+  "ip_address": "1.1.1.1",
+  "server_name": "server-1",
+  "ftp_enabled": "",
+  "sftp_enabled": ""
+}
+```
+
+* `ip_address` (string): The public IP address.
+* `server_name` (string): The name of the frontend server.
+* `ftp_enabled` (string): 
+* `sftp_enabled` (string): 

package/docs/models/PublicKey.md

@@ -0,0 +1,112 @@
+# PublicKey
+
+## Example PublicKey Object
+
+```
+{
+  "id": 1,
+  "title": "My public key",
+  "created_at": "2000-01-01T01:00:00Z",
+  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
+}
+```
+
+* `id` (int64): Public key ID
+* `title` (string): Public key title
+* `created_at` (date-time): Public key created at date/time
+* `fingerprint` (string): Public key fingerprint
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `public_key` (string): Actual contents of SSH key.
+
+---
+
+## List Public Keys
+
+```
+await PublicKey.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 Public Key
+
+```
+await PublicKey.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+
+---
+
+## Create Public Key
+
+```
+await PublicKey.create({
+  'user_id': 1,
+  'title': "My Main Key",
+  'public_key': "public_key",
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `title` (string): Required - Internal reference for key.
+* `public_key` (string): Required - Actual contents of SSH key.
+
+---
+
+## Update Public Key
+
+```
+const [public_key] = await PublicKey.list()
+
+await public_key.update({
+  'title': "My Main Key",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+* `title` (string): Required - Internal reference for key.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "title": "My public key",
+  "created_at": "2000-01-01T01:00:00Z",
+  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
+}
+```
+
+---
+
+## Delete Public Key
+
+```
+const [public_key] = await PublicKey.list()
+
+await public_key.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+

package/docs/models/RemoteBandwidthSnapshot.md

@@ -0,0 +1,42 @@
+# RemoteBandwidthSnapshot
+
+## Example RemoteBandwidthSnapshot Object
+
+```
+{
+  "id": 1,
+  "sync_bytes_received": 1.0,
+  "sync_bytes_sent": 1.0,
+  "logged_at": "2000-01-01T01:00:00Z",
+  "remote_server_id": 1
+}
+```
+
+* `id` (int64): Site bandwidth ID
+* `sync_bytes_received` (double): Site sync bandwidth report bytes received
+* `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
+* `logged_at` (date-time): Time the site bandwidth report was logged
+* `remote_server_id` (int64): ID of related Remote Server
+
+---
+
+## List Remote Bandwidth Snapshots
+
+```
+await RemoteBandwidthSnapshot.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`.