files.com 1.0.157 → 1.0.162
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 +20 -24
- data/docs/automation.md +4 -8
- data/docs/bundle.md +22 -16
- data/docs/bundle_registration.md +2 -0
- data/docs/external_event.md +2 -2
- data/docs/file_comment.md +5 -7
- data/docs/form_field_set.md +18 -20
- data/docs/group.md +1 -1
- data/docs/inbox_registration.md +2 -0
- data/docs/invoice.md +20 -24
- data/docs/message.md +7 -11
- data/docs/message_comment.md +5 -7
- data/docs/payment.md +20 -24
- data/docs/sso_strategy.md +2 -4
- data/docs/status.md +7 -9
- data/docs/sync_job.md +37 -0
- data/lib/files.com.rb +1 -0
- data/lib/files.com/models/account_line_item.rb +2 -2
- data/lib/files.com/models/automation.rb +12 -12
- data/lib/files.com/models/bundle.rb +12 -0
- data/lib/files.com/models/bundle_registration.rb +5 -0
- data/lib/files.com/models/external_event.rb +2 -2
- data/lib/files.com/models/file_comment.rb +1 -1
- data/lib/files.com/models/form_field_set.rb +1 -1
- data/lib/files.com/models/group.rb +1 -1
- data/lib/files.com/models/inbox_registration.rb +5 -0
- data/lib/files.com/models/invoice.rb +2 -2
- data/lib/files.com/models/message.rb +1 -1
- data/lib/files.com/models/message_comment.rb +1 -1
- data/lib/files.com/models/payment.rb +2 -2
- data/lib/files.com/models/sso_strategy.rb +1 -1
- data/lib/files.com/models/status.rb +1 -1
- data/lib/files.com/models/sync_job.rb +58 -0
- 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: a82f98df8c198dc2f6671c69f186af104f4417cba774fb7648e654af8355874b
|
4
|
+
data.tar.gz: bb0f843693107e36c2859b415bf0396f12a939acc8ce6b000d5e98cc7b5d1949
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4dde3c98a50d4e2b8ca60b44ee5f33f155e3eeeb08a34da901a79585f62c98c74e1e650ff8c0daaa471d1a6beeaa881ba79ad453e4b228da604a3dea5ce8c27e
|
7
|
+
data.tar.gz: 4211d6b84aa5df4ae05ce17acaf28eb2146fd3a989f7d8d896f765486dbb8a5887b7079929d3b3a665732efd39954cd10c2d558ae27ae80a2fc6eb2e13b7f2d6
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.162
|
data/docs/account_line_item.md
CHANGED
@@ -10,29 +10,25 @@
|
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
|
-
"invoice_line_items":
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
}
|
25
|
-
],
|
13
|
+
"invoice_line_items": {
|
14
|
+
"amount": 1.0,
|
15
|
+
"created_at": "2000-01-01T01:00:00Z",
|
16
|
+
"description": "Service from 2019-01-01 through 2019-12-31",
|
17
|
+
"type": "invoice",
|
18
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
19
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
20
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
21
|
+
"plan": "Enterprise",
|
22
|
+
"site": "My site"
|
23
|
+
},
|
26
24
|
"method": "paypal",
|
27
|
-
"payment_line_items":
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
}
|
35
|
-
],
|
25
|
+
"payment_line_items": {
|
26
|
+
"amount": 1.0,
|
27
|
+
"created_at": "2000-01-01T01:00:00Z",
|
28
|
+
"invoice_id": 1,
|
29
|
+
"payment_id": 1,
|
30
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
31
|
+
},
|
36
32
|
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
37
33
|
"payment_type": "",
|
38
34
|
"site_name": "My Site",
|
@@ -47,9 +43,9 @@
|
|
47
43
|
* `created_at` (date-time): Line item created at
|
48
44
|
* `currency` (string): Line item currency
|
49
45
|
* `download_uri` (string): Line item download uri
|
50
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items`: Associated invoice line items
|
51
47
|
* `method` (string): Line item payment method
|
52
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items`: Associated payment line items
|
53
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
54
50
|
* `payment_type` (string): Type of payment if applicable
|
55
51
|
* `site_name` (string): Site name this line item is for
|
data/docs/automation.md
CHANGED
@@ -22,7 +22,6 @@
|
|
22
22
|
"time_zone": "Eastern Time (US & Canada)"
|
23
23
|
},
|
24
24
|
"source": "",
|
25
|
-
"destination": "",
|
26
25
|
"destinations": [
|
27
26
|
"destination"
|
28
27
|
],
|
@@ -52,7 +51,6 @@
|
|
52
51
|
* `next_process_on` (string): If trigger is `daily`, date this automation will next run.
|
53
52
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
54
53
|
* `source` (string): Source Path
|
55
|
-
* `destination` (string): DEPRECATED: Destination Path
|
56
54
|
* `destinations` (string): Destination Path
|
57
55
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
58
56
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -64,6 +62,7 @@
|
|
64
62
|
* `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
65
63
|
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
66
64
|
* `value` (object): A Hash of attributes specific to the automation type.
|
65
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
67
66
|
|
68
67
|
|
69
68
|
---
|
@@ -112,7 +111,6 @@ Files::Automation.find(id)
|
|
112
111
|
Files::Automation.create(
|
113
112
|
automation: "create_folder",
|
114
113
|
source: "source",
|
115
|
-
destination: "destination",
|
116
114
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
117
115
|
interval: "year",
|
118
116
|
user_ids: [1,2],
|
@@ -129,7 +127,7 @@ Files::Automation.create(
|
|
129
127
|
|
130
128
|
* `automation` (string): Required - Automation type
|
131
129
|
* `source` (string): Source Path
|
132
|
-
* `destination` (string): DEPRECATED: Destination Path
|
130
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
133
131
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
134
132
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
135
133
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -152,7 +150,6 @@ Files::Automation.create(
|
|
152
150
|
Files::Automation.update(id,
|
153
151
|
automation: "create_folder",
|
154
152
|
source: "source",
|
155
|
-
destination: "destination",
|
156
153
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
157
154
|
interval: "year",
|
158
155
|
user_ids: [1,2],
|
@@ -170,7 +167,7 @@ Files::Automation.update(id,
|
|
170
167
|
* `id` (int64): Required - Automation ID.
|
171
168
|
* `automation` (string): Required - Automation type
|
172
169
|
* `source` (string): Source Path
|
173
|
-
* `destination` (string): DEPRECATED: Destination Path
|
170
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
174
171
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
175
172
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
176
173
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -208,7 +205,6 @@ automation = Files::Automation.list_for(path).first
|
|
208
205
|
automation.update(
|
209
206
|
automation: "create_folder",
|
210
207
|
source: "source",
|
211
|
-
destination: "destination",
|
212
208
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
213
209
|
interval: "year",
|
214
210
|
user_ids: [1,2],
|
@@ -226,7 +222,7 @@ automation.update(
|
|
226
222
|
* `id` (int64): Required - Automation ID.
|
227
223
|
* `automation` (string): Required - Automation type
|
228
224
|
* `source` (string): Source Path
|
229
|
-
* `destination` (string): DEPRECATED: Destination Path
|
225
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
230
226
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
231
227
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
232
228
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
data/docs/bundle.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
"url": "https://subdomain.files.com/f/12345678",
|
9
9
|
"description": "The public description of the bundle.",
|
10
10
|
"password_protected": true,
|
11
|
+
"preview_only": true,
|
11
12
|
"require_registration": true,
|
12
13
|
"require_share_recipient": true,
|
13
14
|
"clickwrap_body": "[Legal text]",
|
@@ -20,22 +21,20 @@
|
|
20
21
|
3,
|
21
22
|
4
|
22
23
|
],
|
23
|
-
"form_fields":
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
"
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
}
|
38
|
-
],
|
24
|
+
"form_fields": {
|
25
|
+
"id": 1,
|
26
|
+
"label": "Sample Label",
|
27
|
+
"required": true,
|
28
|
+
"help_text": "Help Text",
|
29
|
+
"field_type": "text",
|
30
|
+
"options_for_select": [
|
31
|
+
"red",
|
32
|
+
"green",
|
33
|
+
"blue"
|
34
|
+
],
|
35
|
+
"default_option": "red",
|
36
|
+
"form_field_set_id": 1
|
37
|
+
},
|
39
38
|
"skip_name": true,
|
40
39
|
"skip_email": true,
|
41
40
|
"skip_company": true
|
@@ -60,6 +59,7 @@
|
|
60
59
|
* `url` (string): Public URL of Share Link
|
61
60
|
* `description` (string): Public description
|
62
61
|
* `password_protected` (boolean): Is this bundle password protected?
|
62
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
63
63
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
64
64
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
65
65
|
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
|
@@ -132,6 +132,7 @@ Files::Bundle.create(
|
|
132
132
|
description: "The public description of the bundle.",
|
133
133
|
note: "The internal note on the bundle.",
|
134
134
|
code: "abc123",
|
135
|
+
preview_only: true,
|
135
136
|
require_registration: true,
|
136
137
|
clickwrap_id: 1,
|
137
138
|
inbox_id: 1,
|
@@ -150,6 +151,7 @@ Files::Bundle.create(
|
|
150
151
|
* `description` (string): Public description
|
151
152
|
* `note` (string): Bundle internal note
|
152
153
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
154
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
153
155
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
154
156
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
155
157
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
@@ -192,6 +194,7 @@ Files::Bundle.update(id,
|
|
192
194
|
inbox_id: 1,
|
193
195
|
max_uses: 1,
|
194
196
|
note: "The internal note on the bundle.",
|
197
|
+
preview_only: true,
|
195
198
|
require_registration: true,
|
196
199
|
require_share_recipient: true
|
197
200
|
)
|
@@ -210,6 +213,7 @@ Files::Bundle.update(id,
|
|
210
213
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
211
214
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
212
215
|
* `note` (string): Bundle internal note
|
216
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
213
217
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
214
218
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
215
219
|
|
@@ -267,6 +271,7 @@ bundle.update(
|
|
267
271
|
inbox_id: 1,
|
268
272
|
max_uses: 1,
|
269
273
|
note: "The internal note on the bundle.",
|
274
|
+
preview_only: true,
|
270
275
|
require_registration: true,
|
271
276
|
require_share_recipient: true
|
272
277
|
)
|
@@ -285,6 +290,7 @@ bundle.update(
|
|
285
290
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
286
291
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
287
292
|
* `note` (string): Bundle internal note
|
293
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
288
294
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
289
295
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
290
296
|
|
data/docs/bundle_registration.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
"company": "Action Verb",
|
10
10
|
"email": "john.doe@files.com",
|
11
11
|
"inbox_code": "abc123",
|
12
|
+
"clickwrap_body": "",
|
12
13
|
"form_field_set_id": 1,
|
13
14
|
"form_field_data": ""
|
14
15
|
}
|
@@ -19,6 +20,7 @@
|
|
19
20
|
* `company` (string): Registrant company name
|
20
21
|
* `email` (string): Registrant email address
|
21
22
|
* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
|
23
|
+
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
22
24
|
* `form_field_set_id` (int64): Id of associated form field set
|
23
25
|
* `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
|
24
26
|
|
data/docs/external_event.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
}
|
12
12
|
```
|
13
13
|
|
14
|
-
* `event_type` (string): Type of event being recorded.
|
15
|
-
* `status` (string): Status of event.
|
14
|
+
* `event_type` (string): Type of event being recorded.
|
15
|
+
* `status` (string): Status of event.
|
16
16
|
* `body` (string): Event body
|
17
17
|
* `created_at` (date-time): External event create date/time
|
18
18
|
|
data/docs/file_comment.md
CHANGED
@@ -6,18 +6,16 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"body": "What a great file!",
|
9
|
-
"reactions":
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
}
|
14
|
-
]
|
9
|
+
"reactions": {
|
10
|
+
"id": 1,
|
11
|
+
"emoji": "👍"
|
12
|
+
}
|
15
13
|
}
|
16
14
|
```
|
17
15
|
|
18
16
|
* `id` (int64): File Comment ID
|
19
17
|
* `body` (string): Comment body.
|
20
|
-
* `reactions
|
18
|
+
* `reactions`: Reactions to this comment.
|
21
19
|
* `path` (string): File path.
|
22
20
|
|
23
21
|
|
data/docs/form_field_set.md
CHANGED
@@ -12,22 +12,20 @@
|
|
12
12
|
3,
|
13
13
|
4
|
14
14
|
],
|
15
|
-
"form_fields":
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
"
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
}
|
30
|
-
],
|
15
|
+
"form_fields": {
|
16
|
+
"id": 1,
|
17
|
+
"label": "Sample Label",
|
18
|
+
"required": true,
|
19
|
+
"help_text": "Help Text",
|
20
|
+
"field_type": "text",
|
21
|
+
"options_for_select": [
|
22
|
+
"red",
|
23
|
+
"green",
|
24
|
+
"blue"
|
25
|
+
],
|
26
|
+
"default_option": "red",
|
27
|
+
"form_field_set_id": 1
|
28
|
+
},
|
31
29
|
"skip_name": true,
|
32
30
|
"skip_email": true,
|
33
31
|
"skip_company": true
|
@@ -37,7 +35,7 @@
|
|
37
35
|
* `id` (int64): Form field set id
|
38
36
|
* `title` (string): Title to be displayed
|
39
37
|
* `form_layout` (int64): Layout of the form
|
40
|
-
* `form_fields
|
38
|
+
* `form_fields`: Associated form fields
|
41
39
|
* `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
|
42
40
|
* `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
|
43
41
|
* `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
|
@@ -86,7 +84,7 @@ Files::FormFieldSet.create(
|
|
86
84
|
skip_email: true,
|
87
85
|
skip_name: true,
|
88
86
|
skip_company: true,
|
89
|
-
form_fields:
|
87
|
+
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}
|
90
88
|
)
|
91
89
|
```
|
92
90
|
|
@@ -110,7 +108,7 @@ Files::FormFieldSet.update(id,
|
|
110
108
|
skip_email: true,
|
111
109
|
skip_name: true,
|
112
110
|
skip_company: true,
|
113
|
-
form_fields:
|
111
|
+
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}
|
114
112
|
)
|
115
113
|
```
|
116
114
|
|
@@ -149,7 +147,7 @@ form_field_set.update(
|
|
149
147
|
skip_email: true,
|
150
148
|
skip_name: true,
|
151
149
|
skip_company: true,
|
152
|
-
form_fields:
|
150
|
+
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}
|
153
151
|
)
|
154
152
|
```
|
155
153
|
|
data/docs/group.md
CHANGED
@@ -21,7 +21,7 @@
|
|
21
21
|
|
22
22
|
* `id` (int64): Group ID
|
23
23
|
* `name` (string): Group name
|
24
|
-
* `admin_ids` (
|
24
|
+
* `admin_ids` (string): 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/inbox_registration.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
"name": "account",
|
9
9
|
"company": "Action Verb",
|
10
10
|
"email": "john.doe@files.com",
|
11
|
+
"clickwrap_body": "",
|
11
12
|
"form_field_set_id": 1,
|
12
13
|
"form_field_data": ""
|
13
14
|
}
|
@@ -17,6 +18,7 @@
|
|
17
18
|
* `name` (string): Registrant name
|
18
19
|
* `company` (string): Registrant company name
|
19
20
|
* `email` (string): Registrant email address
|
21
|
+
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
20
22
|
* `form_field_set_id` (int64): Id of associated form field set
|
21
23
|
* `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
|
22
24
|
|
data/docs/invoice.md
CHANGED
@@ -10,29 +10,25 @@
|
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
|
-
"invoice_line_items":
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
}
|
25
|
-
],
|
13
|
+
"invoice_line_items": {
|
14
|
+
"amount": 1.0,
|
15
|
+
"created_at": "2000-01-01T01:00:00Z",
|
16
|
+
"description": "Service from 2019-01-01 through 2019-12-31",
|
17
|
+
"type": "invoice",
|
18
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
19
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
20
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
21
|
+
"plan": "Enterprise",
|
22
|
+
"site": "My site"
|
23
|
+
},
|
26
24
|
"method": "paypal",
|
27
|
-
"payment_line_items":
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
}
|
35
|
-
],
|
25
|
+
"payment_line_items": {
|
26
|
+
"amount": 1.0,
|
27
|
+
"created_at": "2000-01-01T01:00:00Z",
|
28
|
+
"invoice_id": 1,
|
29
|
+
"payment_id": 1,
|
30
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
31
|
+
},
|
36
32
|
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
37
33
|
"payment_type": "",
|
38
34
|
"site_name": "My Site",
|
@@ -47,9 +43,9 @@
|
|
47
43
|
* `created_at` (date-time): Line item created at
|
48
44
|
* `currency` (string): Line item currency
|
49
45
|
* `download_uri` (string): Line item download uri
|
50
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items`: Associated invoice line items
|
51
47
|
* `method` (string): Line item payment method
|
52
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items`: Associated payment line items
|
53
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
54
50
|
* `payment_type` (string): Type of payment if applicable
|
55
51
|
* `site_name` (string): Site name this line item is for
|
data/docs/message.md
CHANGED
@@ -7,25 +7,21 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"subject": "Files.com Account Upgrade",
|
9
9
|
"body": "We should upgrade our Files.com account!",
|
10
|
-
"comments":
|
11
|
-
|
10
|
+
"comments": {
|
11
|
+
"id": 1,
|
12
|
+
"body": "What a great idea, thank you!",
|
13
|
+
"reactions": {
|
12
14
|
"id": 1,
|
13
|
-
"
|
14
|
-
"reactions": [
|
15
|
-
{
|
16
|
-
"id": 1,
|
17
|
-
"emoji": "👍"
|
18
|
-
}
|
19
|
-
]
|
15
|
+
"emoji": "👍"
|
20
16
|
}
|
21
|
-
|
17
|
+
}
|
22
18
|
}
|
23
19
|
```
|
24
20
|
|
25
21
|
* `id` (int64): Message ID
|
26
22
|
* `subject` (string): Message subject.
|
27
23
|
* `body` (string): Message body.
|
28
|
-
* `comments
|
24
|
+
* `comments`: Comments.
|
29
25
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
30
26
|
* `project_id` (int64): Project to which the message should be attached.
|
31
27
|
|
data/docs/message_comment.md
CHANGED
@@ -6,18 +6,16 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"body": "What a great idea, thank you!",
|
9
|
-
"reactions":
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
}
|
14
|
-
]
|
9
|
+
"reactions": {
|
10
|
+
"id": 1,
|
11
|
+
"emoji": "👍"
|
12
|
+
}
|
15
13
|
}
|
16
14
|
```
|
17
15
|
|
18
16
|
* `id` (int64): Message Comment ID
|
19
17
|
* `body` (string): Comment body.
|
20
|
-
* `reactions
|
18
|
+
* `reactions`: Reactions to this comment.
|
21
19
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
22
20
|
|
23
21
|
|
data/docs/payment.md
CHANGED
@@ -10,29 +10,25 @@
|
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
|
-
"invoice_line_items":
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
}
|
25
|
-
],
|
13
|
+
"invoice_line_items": {
|
14
|
+
"amount": 1.0,
|
15
|
+
"created_at": "2000-01-01T01:00:00Z",
|
16
|
+
"description": "Service from 2019-01-01 through 2019-12-31",
|
17
|
+
"type": "invoice",
|
18
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
19
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
20
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
21
|
+
"plan": "Enterprise",
|
22
|
+
"site": "My site"
|
23
|
+
},
|
26
24
|
"method": "paypal",
|
27
|
-
"payment_line_items":
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
}
|
35
|
-
],
|
25
|
+
"payment_line_items": {
|
26
|
+
"amount": 1.0,
|
27
|
+
"created_at": "2000-01-01T01:00:00Z",
|
28
|
+
"invoice_id": 1,
|
29
|
+
"payment_id": 1,
|
30
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
31
|
+
},
|
36
32
|
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
37
33
|
"payment_type": "",
|
38
34
|
"site_name": "My Site",
|
@@ -47,9 +43,9 @@
|
|
47
43
|
* `created_at` (date-time): Line item created at
|
48
44
|
* `currency` (string): Line item currency
|
49
45
|
* `download_uri` (string): Line item download uri
|
50
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items`: Associated invoice line items
|
51
47
|
* `method` (string): Line item payment method
|
52
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items`: Associated payment line items
|
53
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
54
50
|
* `payment_type` (string): Type of payment if applicable
|
55
51
|
* `site_name` (string): Site name this line item is for
|
data/docs/sso_strategy.md
CHANGED
@@ -4,9 +4,7 @@
|
|
4
4
|
|
5
5
|
```
|
6
6
|
{
|
7
|
-
"protocol":
|
8
|
-
"okta"
|
9
|
-
],
|
7
|
+
"protocol": "oauth2",
|
10
8
|
"provider": "okta",
|
11
9
|
"label": "My Corporate SSO Provider",
|
12
10
|
"logo_url": "https://mysite.files.com/.../logo.png",
|
@@ -51,7 +49,7 @@
|
|
51
49
|
}
|
52
50
|
```
|
53
51
|
|
54
|
-
* `protocol` (
|
52
|
+
* `protocol` (string): SSO Protocol
|
55
53
|
* `provider` (string): Provider name
|
56
54
|
* `label` (string): Custom label for the SSO provider on the login page.
|
57
55
|
* `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.
|
data/docs/status.md
CHANGED
@@ -8,16 +8,14 @@
|
|
8
8
|
"message": "",
|
9
9
|
"status": "",
|
10
10
|
"data": "",
|
11
|
-
"errors":
|
12
|
-
|
13
|
-
"fields": [
|
11
|
+
"errors": {
|
12
|
+
"fields": [
|
14
13
|
|
15
|
-
|
16
|
-
|
14
|
+
],
|
15
|
+
"messages": [
|
17
16
|
|
18
|
-
|
19
|
-
|
20
|
-
],
|
17
|
+
]
|
18
|
+
},
|
21
19
|
"clickwrap_id": 1,
|
22
20
|
"clickwrap_body": ""
|
23
21
|
}
|
@@ -27,6 +25,6 @@
|
|
27
25
|
* `message` (string): Error message
|
28
26
|
* `status` (string): Status message
|
29
27
|
* `data`: Additional data
|
30
|
-
* `errors
|
28
|
+
* `errors`: A list of api errors
|
31
29
|
* `clickwrap_id` (int64): Required Clickwrap id
|
32
30
|
* `clickwrap_body` (string): Required Clickwrap body
|
data/docs/sync_job.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# SyncJob
|
2
|
+
|
3
|
+
## Example SyncJob Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"queued_at": "2000-01-01T01:00:00Z",
|
8
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
9
|
+
"status": "",
|
10
|
+
"regional_worker_status": "",
|
11
|
+
"uuid": "",
|
12
|
+
"folder_behavior_id": 1
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
* `queued_at` (date-time): Job enqueued at
|
17
|
+
* `updated_at` (date-time): Job updated at
|
18
|
+
* `status` (string): Status of the job
|
19
|
+
* `regional_worker_status` (string): Most recent reported status of sync worker
|
20
|
+
* `uuid` (string):
|
21
|
+
* `folder_behavior_id` (int64):
|
22
|
+
|
23
|
+
|
24
|
+
---
|
25
|
+
|
26
|
+
## List Sync Jobs
|
27
|
+
|
28
|
+
```
|
29
|
+
Files::SyncJob.list(
|
30
|
+
per_page: 1
|
31
|
+
)
|
32
|
+
```
|
33
|
+
|
34
|
+
### Parameters
|
35
|
+
|
36
|
+
* `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 the X-Files-Cursor-Next header.
|
37
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
data/lib/files.com.rb
CHANGED
@@ -85,6 +85,7 @@ require "files.com/models/site"
|
|
85
85
|
require "files.com/models/sso_strategy"
|
86
86
|
require "files.com/models/status"
|
87
87
|
require "files.com/models/style"
|
88
|
+
require "files.com/models/sync_job"
|
88
89
|
require "files.com/models/usage_daily_snapshot"
|
89
90
|
require "files.com/models/usage_snapshot"
|
90
91
|
require "files.com/models/user"
|
@@ -39,7 +39,7 @@ module Files
|
|
39
39
|
@attributes[:download_uri]
|
40
40
|
end
|
41
41
|
|
42
|
-
#
|
42
|
+
# Associated invoice line items
|
43
43
|
def invoice_line_items
|
44
44
|
@attributes[:invoice_line_items]
|
45
45
|
end
|
@@ -49,7 +49,7 @@ module Files
|
|
49
49
|
@attributes[:method]
|
50
50
|
end
|
51
51
|
|
52
|
-
#
|
52
|
+
# Associated payment line items
|
53
53
|
def payment_line_items
|
54
54
|
@attributes[:payment_line_items]
|
55
55
|
end
|
@@ -72,15 +72,6 @@ module Files
|
|
72
72
|
@attributes[:source] = value
|
73
73
|
end
|
74
74
|
|
75
|
-
# string - DEPRECATED: Destination Path
|
76
|
-
def destination
|
77
|
-
@attributes[:destination]
|
78
|
-
end
|
79
|
-
|
80
|
-
def destination=(value)
|
81
|
-
@attributes[:destination] = value
|
82
|
-
end
|
83
|
-
|
84
75
|
# string - Destination Path
|
85
76
|
def destinations
|
86
77
|
@attributes[:destinations]
|
@@ -180,10 +171,19 @@ module Files
|
|
180
171
|
@attributes[:value] = value
|
181
172
|
end
|
182
173
|
|
174
|
+
# string - DEPRECATED: Destination Path. Use `destinations` instead.
|
175
|
+
def destination
|
176
|
+
@attributes[:destination]
|
177
|
+
end
|
178
|
+
|
179
|
+
def destination=(value)
|
180
|
+
@attributes[:destination] = value
|
181
|
+
end
|
182
|
+
|
183
183
|
# Parameters:
|
184
184
|
# automation (required) - string - Automation type
|
185
185
|
# source - string - Source Path
|
186
|
-
# destination - string - DEPRECATED: Destination Path
|
186
|
+
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
187
187
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
188
188
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
189
189
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -294,7 +294,7 @@ module Files
|
|
294
294
|
# Parameters:
|
295
295
|
# automation (required) - string - Automation type
|
296
296
|
# source - string - Source Path
|
297
|
-
# destination - string - DEPRECATED: Destination Path
|
297
|
+
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
298
298
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
299
299
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
300
300
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -332,7 +332,7 @@ module Files
|
|
332
332
|
# Parameters:
|
333
333
|
# automation (required) - string - Automation type
|
334
334
|
# source - string - Source Path
|
335
|
-
# destination - string - DEPRECATED: Destination Path
|
335
|
+
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
336
336
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
337
337
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
338
338
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -45,6 +45,15 @@ module Files
|
|
45
45
|
@attributes[:password_protected] = value
|
46
46
|
end
|
47
47
|
|
48
|
+
# boolean - Restrict users to previewing files only?
|
49
|
+
def preview_only
|
50
|
+
@attributes[:preview_only]
|
51
|
+
end
|
52
|
+
|
53
|
+
def preview_only=(value)
|
54
|
+
@attributes[:preview_only] = value
|
55
|
+
end
|
56
|
+
|
48
57
|
# boolean - Show a registration page that captures the downloader's name and email address?
|
49
58
|
def require_registration
|
50
59
|
@attributes[:require_registration]
|
@@ -224,6 +233,7 @@ module Files
|
|
224
233
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
225
234
|
# max_uses - int64 - Maximum number of times bundle can be accessed
|
226
235
|
# note - string - Bundle internal note
|
236
|
+
# preview_only - boolean - Restrict users to previewing files only?
|
227
237
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
228
238
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
229
239
|
def update(params = {})
|
@@ -327,6 +337,7 @@ module Files
|
|
327
337
|
# description - string - Public description
|
328
338
|
# note - string - Bundle internal note
|
329
339
|
# code - string - Bundle code. This code forms the end part of the Public URL.
|
340
|
+
# preview_only - boolean - Restrict users to previewing files only?
|
330
341
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
331
342
|
# clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
332
343
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
@@ -379,6 +390,7 @@ module Files
|
|
379
390
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
380
391
|
# max_uses - int64 - Maximum number of times bundle can be accessed
|
381
392
|
# note - string - Bundle internal note
|
393
|
+
# preview_only - boolean - Restrict users to previewing files only?
|
382
394
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
383
395
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
384
396
|
def self.update(id, params = {}, options = {})
|
@@ -34,6 +34,11 @@ module Files
|
|
34
34
|
@attributes[:inbox_code]
|
35
35
|
end
|
36
36
|
|
37
|
+
# string - Clickwrap text that was shown to the registrant
|
38
|
+
def clickwrap_body
|
39
|
+
@attributes[:clickwrap_body]
|
40
|
+
end
|
41
|
+
|
37
42
|
# int64 - Id of associated form field set
|
38
43
|
def form_field_set_id
|
39
44
|
@attributes[:form_field_set_id]
|
@@ -9,12 +9,12 @@ module Files
|
|
9
9
|
@options = options || {}
|
10
10
|
end
|
11
11
|
|
12
|
-
# string - Type of event being recorded.
|
12
|
+
# string - Type of event being recorded.
|
13
13
|
def event_type
|
14
14
|
@attributes[:event_type]
|
15
15
|
end
|
16
16
|
|
17
|
-
# string - Status of event.
|
17
|
+
# string - Status of event.
|
18
18
|
def status
|
19
19
|
@attributes[:status]
|
20
20
|
end
|
@@ -27,7 +27,7 @@ module Files
|
|
27
27
|
@attributes[:name] = value
|
28
28
|
end
|
29
29
|
|
30
|
-
#
|
30
|
+
# string - List of user IDs who are group administrators (separated by commas)
|
31
31
|
def admin_ids
|
32
32
|
@attributes[:admin_ids]
|
33
33
|
end
|
@@ -29,6 +29,11 @@ module Files
|
|
29
29
|
@attributes[:email]
|
30
30
|
end
|
31
31
|
|
32
|
+
# string - Clickwrap text that was shown to the registrant
|
33
|
+
def clickwrap_body
|
34
|
+
@attributes[:clickwrap_body]
|
35
|
+
end
|
36
|
+
|
32
37
|
# int64 - Id of associated form field set
|
33
38
|
def form_field_set_id
|
34
39
|
@attributes[:form_field_set_id]
|
@@ -39,7 +39,7 @@ module Files
|
|
39
39
|
@attributes[:download_uri]
|
40
40
|
end
|
41
41
|
|
42
|
-
#
|
42
|
+
# Associated invoice line items
|
43
43
|
def invoice_line_items
|
44
44
|
@attributes[:invoice_line_items]
|
45
45
|
end
|
@@ -49,7 +49,7 @@ module Files
|
|
49
49
|
@attributes[:method]
|
50
50
|
end
|
51
51
|
|
52
|
-
#
|
52
|
+
# Associated payment line items
|
53
53
|
def payment_line_items
|
54
54
|
@attributes[:payment_line_items]
|
55
55
|
end
|
@@ -39,7 +39,7 @@ module Files
|
|
39
39
|
@attributes[:download_uri]
|
40
40
|
end
|
41
41
|
|
42
|
-
#
|
42
|
+
# Associated invoice line items
|
43
43
|
def invoice_line_items
|
44
44
|
@attributes[:invoice_line_items]
|
45
45
|
end
|
@@ -49,7 +49,7 @@ module Files
|
|
49
49
|
@attributes[:method]
|
50
50
|
end
|
51
51
|
|
52
|
-
#
|
52
|
+
# Associated payment line items
|
53
53
|
def payment_line_items
|
54
54
|
@attributes[:payment_line_items]
|
55
55
|
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class SyncJob
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# date-time - Job enqueued at
|
13
|
+
def queued_at
|
14
|
+
@attributes[:queued_at]
|
15
|
+
end
|
16
|
+
|
17
|
+
# date-time - Job updated at
|
18
|
+
def updated_at
|
19
|
+
@attributes[:updated_at]
|
20
|
+
end
|
21
|
+
|
22
|
+
# string - Status of the job
|
23
|
+
def status
|
24
|
+
@attributes[:status]
|
25
|
+
end
|
26
|
+
|
27
|
+
# string - Most recent reported status of sync worker
|
28
|
+
def regional_worker_status
|
29
|
+
@attributes[:regional_worker_status]
|
30
|
+
end
|
31
|
+
|
32
|
+
# string -
|
33
|
+
def uuid
|
34
|
+
@attributes[:uuid]
|
35
|
+
end
|
36
|
+
|
37
|
+
# int64 -
|
38
|
+
def folder_behavior_id
|
39
|
+
@attributes[:folder_behavior_id]
|
40
|
+
end
|
41
|
+
|
42
|
+
# Parameters:
|
43
|
+
# 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 the X-Files-Cursor-Next header.
|
44
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
def self.list(params = {}, options = {})
|
46
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
47
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
48
|
+
|
49
|
+
List.new(SyncJob, params) do
|
50
|
+
Api.send_request("/sync_jobs", :get, params, options)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def self.all(params = {}, options = {})
|
55
|
+
list(params, options)
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.162
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-04-
|
11
|
+
date: 2021-04-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|
@@ -145,6 +145,7 @@ files:
|
|
145
145
|
- docs/sso_strategy.md
|
146
146
|
- docs/status.md
|
147
147
|
- docs/style.md
|
148
|
+
- docs/sync_job.md
|
148
149
|
- docs/usage_daily_snapshot.md
|
149
150
|
- docs/usage_snapshot.md
|
150
151
|
- docs/user.md
|
@@ -217,6 +218,7 @@ files:
|
|
217
218
|
- lib/files.com/models/sso_strategy.rb
|
218
219
|
- lib/files.com/models/status.rb
|
219
220
|
- lib/files.com/models/style.rb
|
221
|
+
- lib/files.com/models/sync_job.rb
|
220
222
|
- lib/files.com/models/usage_daily_snapshot.rb
|
221
223
|
- lib/files.com/models/usage_snapshot.rb
|
222
224
|
- lib/files.com/models/user.rb
|