files.com 1.0.15 → 1.0.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/account_line_item.md +2 -2
- data/docs/action.md +4 -4
- data/docs/api_key.md +11 -0
- data/docs/behavior.md +2 -2
- data/docs/bundle.md +2 -2
- data/docs/dns_record.md +2 -0
- data/docs/group.md +2 -2
- data/docs/group_user.md +2 -2
- data/docs/history.md +9 -9
- data/docs/invoice.md +2 -2
- data/docs/ip_address.md +2 -0
- data/docs/lock.md +2 -2
- data/docs/notification.md +2 -2
- data/docs/payment.md +2 -2
- data/docs/permission.md +2 -2
- data/docs/preview.md +2 -40
- data/docs/public_key.md +3 -3
- data/docs/session.md +0 -85
- data/docs/site.md +3 -92
- data/docs/style.md +4 -2
- data/docs/usage_daily_snapshot.md +37 -0
- data/docs/usage_snapshot.md +22 -4
- data/docs/user.md +3 -3
- data/docs/user_cipher_use.md +4 -4
- data/lib/files.com.rb +1 -14
- data/lib/files.com/models/account_line_item.rb +5 -5
- data/lib/files.com/models/action.rb +6 -6
- data/lib/files.com/models/api_key.rb +14 -0
- data/lib/files.com/models/behavior.rb +9 -9
- data/lib/files.com/models/bundle.rb +9 -9
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/group.rb +9 -9
- data/lib/files.com/models/group_user.rb +9 -9
- data/lib/files.com/models/history.rb +6 -6
- data/lib/files.com/models/invoice.rb +5 -5
- data/lib/files.com/models/ip_address.rb +5 -0
- data/lib/files.com/models/lock.rb +9 -9
- data/lib/files.com/models/notification.rb +9 -9
- data/lib/files.com/models/payment.rb +5 -5
- data/lib/files.com/models/permission.rb +9 -9
- data/lib/files.com/models/preview.rb +5 -45
- data/lib/files.com/models/public_key.rb +9 -9
- data/lib/files.com/models/session.rb +0 -66
- data/lib/files.com/models/site.rb +5 -72
- data/lib/files.com/models/style.rb +14 -5
- data/lib/files.com/models/usage_daily_snapshot.rb +49 -0
- data/lib/files.com/models/usage_snapshot.rb +27 -10
- data/lib/files.com/models/user.rb +9 -9
- data/lib/files.com/models/user_cipher_use.rb +10 -10
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 953363e99c96c344f597293481b7d50745ccc655afaeee38e35abd6951058d9c
|
4
|
+
data.tar.gz: 989563bdf1492d9e6f8567651d2a792c84883a788782d5149b6351d64f251dea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5e19f37250c6b3785d3dd5968346e10428016dd779c6aa5f08d70d359bde4560cf56c40c0290a1320c656d375ea0cd0633190933ed20450ef192ad27f27c312b
|
7
|
+
data.tar.gz: 0f0c1c3c91b6253a5be75b3e7a5f63a2b651d8261e089adcb3b447f461432ab81a3f2467296c8511302c8f8ccc5ee498271c0ae6a0f633512fbd88f565ce8ad1
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.16
|
data/docs/account_line_item.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": 1,
|
7
8
|
"amount": "",
|
8
9
|
"balance": "",
|
9
10
|
"created_at": "2000-01-01 01:00:00 UTC",
|
10
11
|
"currency": "USD",
|
11
12
|
"download_uri": "https://url...",
|
12
|
-
"id": 1,
|
13
13
|
"invoice_line_items": [
|
14
14
|
|
15
15
|
],
|
@@ -25,12 +25,12 @@
|
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
28
|
+
* `id` (int64): Line item Id
|
28
29
|
* `amount` (float): Line item amount
|
29
30
|
* `balance` (float): Line item balance
|
30
31
|
* `created_at` (date-time): Line item created at
|
31
32
|
* `currency` (string): Line item currency
|
32
33
|
* `download_uri` (string): Line item download uri
|
33
|
-
* `id` (int64): Line item Id
|
34
34
|
* `invoice_line_items` (array): Associated invoice line items
|
35
35
|
* `method` (string): Line item payment method
|
36
36
|
* `payment_line_items` (array): Associated payment line items
|
data/docs/action.md
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"path": "path",
|
8
9
|
"when": "2000-01-01 01:00:00 UTC",
|
9
10
|
"destination": "/to_path",
|
10
|
-
"display": "
|
11
|
+
"display": "Actual text of the action here.",
|
11
12
|
"ip": "192.283.128.182",
|
12
|
-
"path": "path",
|
13
13
|
"source": "/from_path",
|
14
14
|
"targets": [
|
15
15
|
|
@@ -23,11 +23,11 @@
|
|
23
23
|
```
|
24
24
|
|
25
25
|
* `id` (int64): Action ID
|
26
|
+
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
26
27
|
* `when` (date-time): Action occurrence date/time
|
27
28
|
* `destination` (string): The destination path for this action, if applicable
|
28
|
-
* `display` (string):
|
29
|
+
* `display` (string): Friendly displayed output
|
29
30
|
* `ip` (string): IP Address that performed this action
|
30
|
-
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
31
31
|
* `source` (string): The source path for this action, if applicable
|
32
32
|
* `targets` (array): Targets
|
33
33
|
* `user_id` (int64): User ID
|
data/docs/api_key.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
|
8
9
|
"created_at": "2000-01-01 01:00:00 UTC",
|
9
10
|
"expires_at": "2000-01-01 01:00:00 UTC",
|
10
11
|
"key": "[key]",
|
@@ -17,6 +18,7 @@
|
|
17
18
|
```
|
18
19
|
|
19
20
|
* `id` (int64): API Key ID
|
21
|
+
* `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.
|
20
22
|
* `created_at` (date-time): Time which API Key was created
|
21
23
|
* `expires_at` (date-time): API Key expiration date
|
22
24
|
* `key` (string): API Key actual key string
|
@@ -47,6 +49,15 @@ Files::ApiKey.list(
|
|
47
49
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
48
50
|
|
49
51
|
|
52
|
+
---
|
53
|
+
|
54
|
+
## Show information about current API key. (Requires current API connection to be using an API key.)
|
55
|
+
|
56
|
+
```
|
57
|
+
Files::ApiKey.get
|
58
|
+
```
|
59
|
+
|
60
|
+
|
50
61
|
---
|
51
62
|
|
52
63
|
## Show Api Key
|
data/docs/behavior.md
CHANGED
@@ -5,9 +5,9 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"path": "",
|
8
9
|
"attachment_url": "",
|
9
10
|
"behavior": "webhook",
|
10
|
-
"path": "",
|
11
11
|
"value": {
|
12
12
|
"method": "GET"
|
13
13
|
}
|
@@ -15,9 +15,9 @@
|
|
15
15
|
```
|
16
16
|
|
17
17
|
* `id` (int64): Folder behavior ID
|
18
|
+
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
18
19
|
* `attachment_url` (string): URL for attached file
|
19
20
|
* `behavior` (string): Behavior type.
|
20
|
-
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
21
21
|
* `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.
|
22
22
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
23
23
|
|
data/docs/bundle.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": 1,
|
7
8
|
"code": "abc123",
|
8
9
|
"created_at": "2000-01-01 01:00:00 UTC",
|
9
10
|
"description": "The public description of the bundle.",
|
@@ -11,7 +12,6 @@
|
|
11
12
|
"paths": [
|
12
13
|
|
13
14
|
],
|
14
|
-
"id": 1,
|
15
15
|
"note": "The internal note on the bundle.",
|
16
16
|
"password_protected": true,
|
17
17
|
"url": "https://subdomain.files.com/f/12345678",
|
@@ -20,12 +20,12 @@
|
|
20
20
|
}
|
21
21
|
```
|
22
22
|
|
23
|
+
* `id` (int64): Bundle ID
|
23
24
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
24
25
|
* `created_at` (date-time): Bundle created at date/time
|
25
26
|
* `description` (string): Public description
|
26
27
|
* `expires_at` (date-time): Bundle expiration date/time
|
27
28
|
* `paths` (array): A list of paths in this bundle
|
28
|
-
* `id` (int64): Bundle ID
|
29
29
|
* `note` (string): Bundle internal note
|
30
30
|
* `password_protected` (boolean): Is this bundle password protected?
|
31
31
|
* `url` (string): Public URL of Share Link
|
data/docs/dns_record.md
CHANGED
@@ -4,12 +4,14 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": "customdomain.com-CNAME-site.files.com",
|
7
8
|
"domain": "my-custom-domain.com",
|
8
9
|
"rrtype": "CNAME",
|
9
10
|
"value": "mysite.files.com"
|
10
11
|
}
|
11
12
|
```
|
12
13
|
|
14
|
+
* `id` (string): Unique label for DNS record; used by Zapier and other integrations.
|
13
15
|
* `domain` (string): DNS record domain name
|
14
16
|
* `rrtype` (string): DNS record type
|
15
17
|
* `value` (string): DNS record value
|
data/docs/group.md
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"name": "owners",
|
8
9
|
"admin_ids": [
|
9
10
|
|
10
11
|
],
|
11
|
-
"name": "owners",
|
12
12
|
"notes": "",
|
13
13
|
"user_ids": [
|
14
14
|
|
@@ -20,8 +20,8 @@
|
|
20
20
|
```
|
21
21
|
|
22
22
|
* `id` (int64): Group ID
|
23
|
-
* `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
|
24
23
|
* `name` (string): Group name
|
24
|
+
* `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
|
25
25
|
* `notes` (string): Notes about this group
|
26
26
|
* `user_ids` (array): List of user IDs who belong to this group (separated by commas)
|
27
27
|
* `usernames` (array): List of usernames who belong to this group (separated by commas)
|
data/docs/group_user.md
CHANGED
@@ -4,18 +4,18 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"name": "My Group",
|
7
8
|
"id": 1,
|
8
9
|
"admin": true,
|
9
|
-
"name": "My Group",
|
10
10
|
"usernames": [
|
11
11
|
|
12
12
|
]
|
13
13
|
}
|
14
14
|
```
|
15
15
|
|
16
|
+
* `name` (string): Group name
|
16
17
|
* `id` (int64): Group ID
|
17
18
|
* `admin` (boolean): Is this user an administrator of this group?
|
18
|
-
* `name` (string): Group name
|
19
19
|
* `usernames` (array): A list of usernames for users in this group
|
20
20
|
* `group_id` (int64): Group ID to add user to.
|
21
21
|
* `user_id` (int64): User ID to add to group.
|
data/docs/history.md
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"path": "path",
|
8
9
|
"when": "2000-01-01 01:00:00 UTC",
|
9
10
|
"destination": "/to_path",
|
10
|
-
"display": "
|
11
|
+
"display": "Actual text of the action here.",
|
11
12
|
"ip": "192.283.128.182",
|
12
|
-
"path": "path",
|
13
13
|
"source": "/from_path",
|
14
14
|
"targets": [
|
15
15
|
|
@@ -23,11 +23,11 @@
|
|
23
23
|
```
|
24
24
|
|
25
25
|
* `id` (int64): Action ID
|
26
|
+
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
26
27
|
* `when` (date-time): Action occurrence date/time
|
27
28
|
* `destination` (string): The destination path for this action, if applicable
|
28
|
-
* `display` (string):
|
29
|
+
* `display` (string): Friendly displayed output
|
29
30
|
* `ip` (string): IP Address that performed this action
|
30
|
-
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
31
31
|
* `source` (string): The source path for this action, if applicable
|
32
32
|
* `targets` (array): Targets
|
33
33
|
* `user_id` (int64): User ID
|
@@ -43,7 +43,7 @@
|
|
43
43
|
|
44
44
|
```
|
45
45
|
Files::History.list_for_file(path,
|
46
|
-
display: "
|
46
|
+
display: "Actual text of the action here.",
|
47
47
|
page: 1,
|
48
48
|
per_page: 1,
|
49
49
|
action: "create"
|
@@ -67,7 +67,7 @@ Files::History.list_for_file(path,
|
|
67
67
|
|
68
68
|
```
|
69
69
|
Files::History.list_for_folder(path,
|
70
|
-
display: "
|
70
|
+
display: "Actual text of the action here.",
|
71
71
|
page: 1,
|
72
72
|
per_page: 1,
|
73
73
|
action: "create"
|
@@ -91,7 +91,7 @@ Files::History.list_for_folder(path,
|
|
91
91
|
|
92
92
|
```
|
93
93
|
Files::History.list_for_user(user_id,
|
94
|
-
display: "
|
94
|
+
display: "Actual text of the action here.",
|
95
95
|
page: 1,
|
96
96
|
per_page: 1,
|
97
97
|
action: "create"
|
@@ -115,7 +115,7 @@ Files::History.list_for_user(user_id,
|
|
115
115
|
|
116
116
|
```
|
117
117
|
Files::History.list_logins(
|
118
|
-
display: "
|
118
|
+
display: "Actual text of the action here.",
|
119
119
|
page: 1,
|
120
120
|
per_page: 1,
|
121
121
|
action: "create"
|
@@ -138,7 +138,7 @@ Files::History.list_logins(
|
|
138
138
|
|
139
139
|
```
|
140
140
|
Files::History.list(
|
141
|
-
display: "
|
141
|
+
display: "Actual text of the action here.",
|
142
142
|
page: 1,
|
143
143
|
per_page: 1,
|
144
144
|
action: "create"
|
data/docs/invoice.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": 1,
|
7
8
|
"amount": "",
|
8
9
|
"balance": "",
|
9
10
|
"created_at": "2000-01-01 01:00:00 UTC",
|
10
11
|
"currency": "USD",
|
11
12
|
"download_uri": "https://url...",
|
12
|
-
"id": 1,
|
13
13
|
"invoice_line_items": [
|
14
14
|
|
15
15
|
],
|
@@ -25,12 +25,12 @@
|
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
28
|
+
* `id` (int64): Line item Id
|
28
29
|
* `amount` (float): Line item amount
|
29
30
|
* `balance` (float): Line item balance
|
30
31
|
* `created_at` (date-time): Line item created at
|
31
32
|
* `currency` (string): Line item currency
|
32
33
|
* `download_uri` (string): Line item download uri
|
33
|
-
* `id` (int64): Line item Id
|
34
34
|
* `invoice_line_items` (array): Associated invoice line items
|
35
35
|
* `method` (string): Line item payment method
|
36
36
|
* `payment_line_items` (array): Associated payment line items
|
data/docs/ip_address.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": "Site",
|
7
8
|
"associated_with": "Site",
|
8
9
|
"group_id": 1,
|
9
10
|
"ip_addresses": [
|
@@ -12,6 +13,7 @@
|
|
12
13
|
}
|
13
14
|
```
|
14
15
|
|
16
|
+
* `id` (string): Unique label for list; used by Zapier and other integrations.
|
15
17
|
* `associated_with` (string): The object that this public IP address list is associated with.
|
16
18
|
* `group_id` (int64): Group ID
|
17
19
|
* `ip_addresses` (array): A list of IP addresses.
|
data/docs/lock.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"path": "locked_file",
|
7
8
|
"timeout": 43200,
|
8
9
|
"depth": "infinity",
|
9
10
|
"owner": "user",
|
10
|
-
"path": "locked_file",
|
11
11
|
"scope": "shared",
|
12
12
|
"token": "17c54824e9931a4688ca032d03f6663c",
|
13
13
|
"type": "write",
|
@@ -16,10 +16,10 @@
|
|
16
16
|
}
|
17
17
|
```
|
18
18
|
|
19
|
+
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
19
20
|
* `timeout` (int64): Lock timeout
|
20
21
|
* `depth` (string): Lock depth (0 or infinity)
|
21
22
|
* `owner` (string): Owner of lock. This can be any arbitrary string.
|
22
|
-
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
23
23
|
* `scope` (string): Lock scope(shared or exclusive)
|
24
24
|
* `token` (string): Lock token. Use to release lock.
|
25
25
|
* `type` (string): Lock type
|
data/docs/notification.md
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"path": "path",
|
8
9
|
"group_id": 1,
|
9
10
|
"group_name": "",
|
10
11
|
"notify_user_actions": true,
|
11
12
|
"notify_on_copy": true,
|
12
|
-
"path": "path",
|
13
13
|
"send_interval": "fifteen_minutes",
|
14
14
|
"unsubscribed": true,
|
15
15
|
"unsubscribed_reason": "",
|
@@ -19,11 +19,11 @@
|
|
19
19
|
```
|
20
20
|
|
21
21
|
* `id` (int64): Notification ID
|
22
|
+
* `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.
|
22
23
|
* `group_id` (int64): Notification group id
|
23
24
|
* `group_name` (string): Group name if applicable
|
24
25
|
* `notify_user_actions` (boolean): Trigger notification on notification user actions?
|
25
26
|
* `notify_on_copy` (boolean): Triggers notification when moving or copying files to this path
|
26
|
-
* `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.
|
27
27
|
* `send_interval` (string): The time interval that notifications are aggregated to
|
28
28
|
* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
|
29
29
|
* `unsubscribed_reason` (string): The reason that the user unsubscribed
|
data/docs/payment.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": 1,
|
7
8
|
"amount": "",
|
8
9
|
"balance": "",
|
9
10
|
"created_at": "2000-01-01 01:00:00 UTC",
|
10
11
|
"currency": "USD",
|
11
12
|
"download_uri": "https://url...",
|
12
|
-
"id": 1,
|
13
13
|
"invoice_line_items": [
|
14
14
|
|
15
15
|
],
|
@@ -25,12 +25,12 @@
|
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
28
|
+
* `id` (int64): Line item Id
|
28
29
|
* `amount` (float): Line item amount
|
29
30
|
* `balance` (float): Line item balance
|
30
31
|
* `created_at` (date-time): Line item created at
|
31
32
|
* `currency` (string): Line item currency
|
32
33
|
* `download_uri` (string): Line item download uri
|
33
|
-
* `id` (int64): Line item Id
|
34
34
|
* `invoice_line_items` (array): Associated invoice line items
|
35
35
|
* `method` (string): Line item payment method
|
36
36
|
* `payment_line_items` (array): Associated payment line items
|
data/docs/permission.md
CHANGED
@@ -5,22 +5,22 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"path": "",
|
8
9
|
"user_id": 1,
|
9
10
|
"username": "Sser",
|
10
11
|
"group_id": 1,
|
11
12
|
"group_name": "",
|
12
|
-
"path": "",
|
13
13
|
"permission": "full",
|
14
14
|
"recursive": true
|
15
15
|
}
|
16
16
|
```
|
17
17
|
|
18
18
|
* `id` (int64): Permission ID
|
19
|
+
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
19
20
|
* `user_id` (int64): User ID
|
20
21
|
* `username` (string): User's username
|
21
22
|
* `group_id` (int64): Group ID
|
22
23
|
* `group_name` (string): Group name if applicable
|
23
|
-
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
24
24
|
* `permission` (string): Permission type
|
25
25
|
* `recursive` (boolean): Does this permission apply to subfolders?
|
26
26
|
|
data/docs/preview.md
CHANGED
@@ -4,54 +4,16 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
+
"id": 1,
|
7
8
|
"status": "complete",
|
8
9
|
"download_uri": "https://mysite.files.com/...",
|
9
|
-
"id": 1,
|
10
10
|
"type": "complete",
|
11
11
|
"size": 1024
|
12
12
|
}
|
13
13
|
```
|
14
14
|
|
15
|
+
* `id` (int64): Preview ID
|
15
16
|
* `status` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
|
16
17
|
* `download_uri` (string): Link to download preview
|
17
|
-
* `id` (int64): Preview ID
|
18
18
|
* `type` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
|
19
19
|
* `size` (int64): Preview size
|
20
|
-
|
21
|
-
|
22
|
-
---
|
23
|
-
|
24
|
-
## Show many previews at once
|
25
|
-
|
26
|
-
```
|
27
|
-
Files::Preview.list(
|
28
|
-
page: 1,
|
29
|
-
per_page: 1,
|
30
|
-
ids: "ids",
|
31
|
-
size: "large"
|
32
|
-
)
|
33
|
-
```
|
34
|
-
|
35
|
-
### Parameters
|
36
|
-
|
37
|
-
* `page` (int64): Current page number.
|
38
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
40
|
-
* `ids` (string): Required - Preview IDs. Comma delimited.
|
41
|
-
* `size` (string): Preview Size
|
42
|
-
|
43
|
-
|
44
|
-
---
|
45
|
-
|
46
|
-
## Show Preview
|
47
|
-
|
48
|
-
```
|
49
|
-
Files::Preview.find(id,
|
50
|
-
size: "large"
|
51
|
-
)
|
52
|
-
```
|
53
|
-
|
54
|
-
### Parameters
|
55
|
-
|
56
|
-
* `id` (int64): Required - Preview ID.
|
57
|
-
* `size` (string): Preview Size
|