files.com 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d33719015bdad22a7ad9ae28c3fc1e62d17b166cc1cdcac9fb961e2c9dfb9855
-  data.tar.gz: 4bbc134f2c96695ce5b60307ed70b592da242b09ed12e7e2d70969b86dd94d2a
+  metadata.gz: 953363e99c96c344f597293481b7d50745ccc655afaeee38e35abd6951058d9c
+  data.tar.gz: 989563bdf1492d9e6f8567651d2a792c84883a788782d5149b6351d64f251dea
 SHA512:
-  metadata.gz: c456e73c2f289abeb06701835cd389572634c13270de4fde9f049e273debc99cbf73dad8c45372d9e1053e63a55637e24bd153a5cb6d0447c3602435685bca96
-  data.tar.gz: 43857799974164dd1fb14c225e579fef94b9dd89206f52ac8b3ece91c642daee6e100b1234d49cafc711dab969d130d7e8640df4a01c8b6b2f72af108f7beba4
+  metadata.gz: 5e19f37250c6b3785d3dd5968346e10428016dd779c6aa5f08d70d359bde4560cf56c40c0290a1320c656d375ea0cd0633190933ed20450ef192ad27f27c312b
+  data.tar.gz: 0f0c1c3c91b6253a5be75b3e7a5f63a2b651d8261e089adcb3b447f461432ab81a3f2467296c8511302c8f8ccc5ee498271c0ae6a0f633512fbd88f565ce8ad1

data/_VERSION

@@ -1 +1 @@
-1.0.15
+1.0.16

data/docs/account_line_item.md

@@ -4,12 +4,12 @@
 
 ```
 {
+  "id": 1,
   "amount": "",
   "balance": "",
   "created_at": "2000-01-01 01:00:00 UTC",
   "currency": "USD",
   "download_uri": "https://url...",
-  "id": 1,
   "invoice_line_items": [
 
   ],
@@ -25,12 +25,12 @@
 }
 ```
 
+* `id` (int64): Line item Id
 * `amount` (float): Line item amount
 * `balance` (float): Line item balance
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `id` (int64): Line item Id
 * `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
 * `payment_line_items` (array): Associated payment line items

data/docs/action.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
+  "path": "path",
   "when": "2000-01-01 01:00:00 UTC",
   "destination": "/to_path",
-  "display": "full",
+  "display": "Actual text of the action here.",
   "ip": "192.283.128.182",
-  "path": "path",
   "source": "/from_path",
   "targets": [
 
@@ -23,11 +23,11 @@
 ```
 
 * `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): Display format
+* `display` (string): Friendly displayed output
 * `ip` (string): IP Address that performed this action
-* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `source` (string): The source path for this action, if applicable
 * `targets` (array): Targets
 * `user_id` (int64): User ID

data/docs/api_key.md

@@ -5,6 +5,7 @@
 ```
 {
   "id": 1,
+  "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
   "created_at": "2000-01-01 01:00:00 UTC",
   "expires_at": "2000-01-01 01:00:00 UTC",
   "key": "[key]",
@@ -17,6 +18,7 @@
 ```
 
 * `id` (int64): API Key ID
+* `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
 * `created_at` (date-time): Time which API Key was created
 * `expires_at` (date-time): API Key expiration date
 * `key` (string): API Key actual key string
@@ -47,6 +49,15 @@ Files::ApiKey.list(
 * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
 
 
+---
+
+## Show information about current API key.  (Requires current API connection to be using an API key.)
+
+```
+Files::ApiKey.get
+```
+
+
 ---
 
 ## Show Api Key

data/docs/behavior.md

@@ -5,9 +5,9 @@
 ```
 {
   "id": 1,
+  "path": "",
   "attachment_url": "",
   "behavior": "webhook",
-  "path": "",
   "value": {
     "method": "GET"
   }
@@ -15,9 +15,9 @@
 ```
 
 * `id` (int64): Folder behavior ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `attachment_url` (string): URL for attached file
 * `behavior` (string): Behavior type.
-* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `value` (object): Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
 * `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
 

data/docs/bundle.md

@@ -4,6 +4,7 @@
 
 ```
 {
+  "id": 1,
   "code": "abc123",
   "created_at": "2000-01-01 01:00:00 UTC",
   "description": "The public description of the bundle.",
@@ -11,7 +12,6 @@
   "paths": [
 
   ],
-  "id": 1,
   "note": "The internal note on the bundle.",
   "password_protected": true,
   "url": "https://subdomain.files.com/f/12345678",
@@ -20,12 +20,12 @@
 }
 ```
 
+* `id` (int64): Bundle ID
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `created_at` (date-time): Bundle created at date/time
 * `description` (string): Public description
 * `expires_at` (date-time): Bundle expiration date/time
 * `paths` (array): A list of paths in this bundle
-* `id` (int64): Bundle ID
 * `note` (string): Bundle internal note
 * `password_protected` (boolean): Is this bundle password protected?
 * `url` (string): Public URL of Share Link

data/docs/dns_record.md

@@ -4,12 +4,14 @@
 
 ```
 {
+  "id": "customdomain.com-CNAME-site.files.com",
   "domain": "my-custom-domain.com",
   "rrtype": "CNAME",
   "value": "mysite.files.com"
 }
 ```
 
+* `id` (string): Unique label for DNS record; used by Zapier and other integrations.
 * `domain` (string): DNS record domain name
 * `rrtype` (string): DNS record type
 * `value` (string): DNS record value

data/docs/group.md

@@ -5,10 +5,10 @@
 ```
 {
   "id": 1,
+  "name": "owners",
   "admin_ids": [
 
   ],
-  "name": "owners",
   "notes": "",
   "user_ids": [
 
@@ -20,8 +20,8 @@
 ```
 
 * `id` (int64): Group ID
-* `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
 * `name` (string): Group name
+* `admin_ids` (array): 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)

data/docs/group_user.md

@@ -4,18 +4,18 @@
 
 ```
 {
+  "name": "My Group",
   "id": 1,
   "admin": true,
-  "name": "My Group",
   "usernames": [
 
   ]
 }
 ```
 
+* `name` (string): Group name
 * `id` (int64): Group ID
 * `admin` (boolean): Is this user an administrator of this group?
-* `name` (string): Group name
 * `usernames` (array): A list of usernames for users in this group
 * `group_id` (int64): Group ID to add user to.
 * `user_id` (int64): User ID to add to group.

data/docs/history.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
+  "path": "path",
   "when": "2000-01-01 01:00:00 UTC",
   "destination": "/to_path",
-  "display": "full",
+  "display": "Actual text of the action here.",
   "ip": "192.283.128.182",
-  "path": "path",
   "source": "/from_path",
   "targets": [
 
@@ -23,11 +23,11 @@
 ```
 
 * `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): Display format
+* `display` (string): Friendly displayed output
 * `ip` (string): IP Address that performed this action
-* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `source` (string): The source path for this action, if applicable
 * `targets` (array): Targets
 * `user_id` (int64): User ID
@@ -43,7 +43,7 @@
 
 ```
 Files::History.list_for_file(path, 
-  display: "full", 
+  display: "Actual text of the action here.", 
   page: 1, 
   per_page: 1, 
   action: "create"
@@ -67,7 +67,7 @@ Files::History.list_for_file(path,
 
 ```
 Files::History.list_for_folder(path, 
-  display: "full", 
+  display: "Actual text of the action here.", 
   page: 1, 
   per_page: 1, 
   action: "create"
@@ -91,7 +91,7 @@ Files::History.list_for_folder(path,
 
 ```
 Files::History.list_for_user(user_id, 
-  display: "full", 
+  display: "Actual text of the action here.", 
   page: 1, 
   per_page: 1, 
   action: "create"
@@ -115,7 +115,7 @@ Files::History.list_for_user(user_id,
 
 ```
 Files::History.list_logins(
-  display: "full", 
+  display: "Actual text of the action here.", 
   page: 1, 
   per_page: 1, 
   action: "create"
@@ -138,7 +138,7 @@ Files::History.list_logins(
 
 ```
 Files::History.list(
-  display: "full", 
+  display: "Actual text of the action here.", 
   page: 1, 
   per_page: 1, 
   action: "create"

data/docs/invoice.md

@@ -4,12 +4,12 @@
 
 ```
 {
+  "id": 1,
   "amount": "",
   "balance": "",
   "created_at": "2000-01-01 01:00:00 UTC",
   "currency": "USD",
   "download_uri": "https://url...",
-  "id": 1,
   "invoice_line_items": [
 
   ],
@@ -25,12 +25,12 @@
 }
 ```
 
+* `id` (int64): Line item Id
 * `amount` (float): Line item amount
 * `balance` (float): Line item balance
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `id` (int64): Line item Id
 * `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
 * `payment_line_items` (array): Associated payment line items

data/docs/ip_address.md

@@ -4,6 +4,7 @@
 
 ```
 {
+  "id": "Site",
   "associated_with": "Site",
   "group_id": 1,
   "ip_addresses": [
@@ -12,6 +13,7 @@
 }
 ```
 
+* `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.

data/docs/lock.md

@@ -4,10 +4,10 @@
 
 ```
 {
+  "path": "locked_file",
   "timeout": 43200,
   "depth": "infinity",
   "owner": "user",
-  "path": "locked_file",
   "scope": "shared",
   "token": "17c54824e9931a4688ca032d03f6663c",
   "type": "write",
@@ -16,10 +16,10 @@
 }
 ```
 
+* `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
 * `depth` (string): Lock depth (0 or infinity)
 * `owner` (string): Owner of lock.  This can be any arbitrary string.
-* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `scope` (string): Lock scope(shared or exclusive)
 * `token` (string): Lock token.  Use to release lock.
 * `type` (string): Lock type

data/docs/notification.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
+  "path": "path",
   "group_id": 1,
   "group_name": "",
   "notify_user_actions": true,
   "notify_on_copy": true,
-  "path": "path",
   "send_interval": "fifteen_minutes",
   "unsubscribed": true,
   "unsubscribed_reason": "",
@@ -19,11 +19,11 @@
 ```
 
 * `id` (int64): Notification ID
+* `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `group_id` (int64): Notification group id
 * `group_name` (string): Group name if applicable
 * `notify_user_actions` (boolean): Trigger notification on notification user actions?
 * `notify_on_copy` (boolean): Triggers notification when moving or copying files to this path
-* `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `send_interval` (string): The time interval that notifications are aggregated to
 * `unsubscribed` (boolean): Is the user unsubscribed from this notification?
 * `unsubscribed_reason` (string): The reason that the user unsubscribed

data/docs/payment.md

@@ -4,12 +4,12 @@
 
 ```
 {
+  "id": 1,
   "amount": "",
   "balance": "",
   "created_at": "2000-01-01 01:00:00 UTC",
   "currency": "USD",
   "download_uri": "https://url...",
-  "id": 1,
   "invoice_line_items": [
 
   ],
@@ -25,12 +25,12 @@
 }
 ```
 
+* `id` (int64): Line item Id
 * `amount` (float): Line item amount
 * `balance` (float): Line item balance
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
-* `id` (int64): Line item Id
 * `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
 * `payment_line_items` (array): Associated payment line items

data/docs/permission.md

@@ -5,22 +5,22 @@
 ```
 {
   "id": 1,
+  "path": "",
   "user_id": 1,
   "username": "Sser",
   "group_id": 1,
   "group_name": "",
-  "path": "",
   "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
-* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `permission` (string): Permission type
 * `recursive` (boolean): Does this permission apply to subfolders?
 

data/docs/preview.md

@@ -4,54 +4,16 @@
 
 ```
 {
+  "id": 1,
   "status": "complete",
   "download_uri": "https://mysite.files.com/...",
-  "id": 1,
   "type": "complete",
   "size": 1024
 }
 ```
 
+* `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
-* `id` (int64): Preview ID
 * `type` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
 * `size` (int64): Preview size
-
-
----
-
-## Show many previews at once
-
-```
-Files::Preview.list(
-  page: 1, 
-  per_page: 1, 
-  ids: "ids", 
-  size: "large"
-)
-```
-
-### Parameters
-
-* `page` (int64): Current page number.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `ids` (string): Required - Preview IDs.  Comma delimited.
-* `size` (string): Preview Size
-
-
----
-
-## Show Preview
-
-```
-Files::Preview.find(id, 
-  size: "large"
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Preview ID.
-* `size` (string): Preview Size