files.com 1.0.120 → 1.0.125

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/api_key.md +1 -4
  4. data/docs/app.md +1 -4
  5. data/docs/as2_key.md +1 -4
  6. data/docs/automation.md +35 -11
  7. data/docs/bandwidth_snapshot.md +1 -4
  8. data/docs/behavior.md +2 -8
  9. data/docs/bundle.md +11 -6
  10. data/docs/bundle_download.md +1 -4
  11. data/docs/bundle_recipient.md +1 -4
  12. data/docs/clickwrap.md +3 -5
  13. data/docs/dns_record.md +1 -4
  14. data/docs/external_event.md +1 -4
  15. data/docs/file_comment.md +1 -4
  16. data/docs/folder.md +1 -4
  17. data/docs/group.md +1 -4
  18. data/docs/group_user.md +1 -4
  19. data/docs/history.md +10 -30
  20. data/docs/history_export_result.md +1 -5
  21. data/docs/invoice.md +1 -4
  22. data/docs/ip_address.md +2 -8
  23. data/docs/lock.md +1 -4
  24. data/docs/message.md +1 -4
  25. data/docs/message_comment.md +1 -4
  26. data/docs/message_comment_reaction.md +1 -4
  27. data/docs/message_reaction.md +1 -4
  28. data/docs/notification.md +1 -4
  29. data/docs/payment.md +1 -4
  30. data/docs/permission.md +1 -4
  31. data/docs/project.md +1 -4
  32. data/docs/public_key.md +1 -4
  33. data/docs/remote_server.md +60 -4
  34. data/docs/request.md +2 -8
  35. data/docs/settings_change.md +1 -4
  36. data/docs/sso_strategy.md +5 -4
  37. data/docs/usage_daily_snapshot.md +1 -4
  38. data/docs/usage_snapshot.md +1 -4
  39. data/docs/user.md +1 -4
  40. data/docs/user_cipher_use.md +1 -4
  41. data/docs/user_request.md +1 -4
  42. data/lib/files.com/models/api_key.rb +2 -6
  43. data/lib/files.com/models/app.rb +2 -6
  44. data/lib/files.com/models/as2_key.rb +2 -6
  45. data/lib/files.com/models/automation.rb +34 -9
  46. data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
  47. data/lib/files.com/models/behavior.rb +4 -12
  48. data/lib/files.com/models/bundle.rb +10 -6
  49. data/lib/files.com/models/bundle_download.rb +2 -6
  50. data/lib/files.com/models/bundle_recipient.rb +2 -6
  51. data/lib/files.com/models/clickwrap.rb +11 -15
  52. data/lib/files.com/models/dns_record.rb +2 -6
  53. data/lib/files.com/models/external_event.rb +2 -6
  54. data/lib/files.com/models/file_comment.rb +2 -6
  55. data/lib/files.com/models/folder.rb +2 -6
  56. data/lib/files.com/models/group.rb +2 -6
  57. data/lib/files.com/models/group_user.rb +2 -6
  58. data/lib/files.com/models/history.rb +10 -30
  59. data/lib/files.com/models/history_export_result.rb +2 -6
  60. data/lib/files.com/models/invoice.rb +2 -6
  61. data/lib/files.com/models/ip_address.rb +4 -12
  62. data/lib/files.com/models/lock.rb +2 -6
  63. data/lib/files.com/models/message.rb +2 -6
  64. data/lib/files.com/models/message_comment.rb +2 -6
  65. data/lib/files.com/models/message_comment_reaction.rb +2 -6
  66. data/lib/files.com/models/message_reaction.rb +2 -6
  67. data/lib/files.com/models/notification.rb +2 -6
  68. data/lib/files.com/models/payment.rb +2 -6
  69. data/lib/files.com/models/permission.rb +2 -6
  70. data/lib/files.com/models/project.rb +2 -6
  71. data/lib/files.com/models/public_key.rb +2 -6
  72. data/lib/files.com/models/remote_server.rb +99 -6
  73. data/lib/files.com/models/request.rb +4 -12
  74. data/lib/files.com/models/settings_change.rb +2 -6
  75. data/lib/files.com/models/sso_strategy.rb +12 -6
  76. data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
  77. data/lib/files.com/models/usage_snapshot.rb +2 -6
  78. data/lib/files.com/models/user.rb +2 -6
  79. data/lib/files.com/models/user_cipher_use.rb +2 -6
  80. data/lib/files.com/models/user_request.rb +2 -6
  81. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c7858069f7ee082ef8708a4854a8d6910420cda11c1548e69d9e441edd59dc42
4
- data.tar.gz: 77db67aaec21410ab24d36e754253fe18866112fefd467f55b885f256ae5a9ef
3
+ metadata.gz: cfa34129d6329335d7a9b4e2ba3cd49af79efd898a53c18b6b67e3db6c47d10c
4
+ data.tar.gz: eebdf00c2b5b09259af307e379490a7aaa86adea23f9fbc7650dfd649e34eb1d
5
5
  SHA512:
6
- metadata.gz: 60990355eadc3253ff56c945c8db60074e86eb18bcd62d04ca0ed79183b7a7fe76c1a0f51ec923e2e95ae9cd2c7c95efeab4af7795bd97b09a6ae5f1bb7469e5
7
- data.tar.gz: 1320d69eb5b98246dbd4367cedbde48f8587868504a7ca728a193938bf4ab1af46b7694ffe23db0dbc1a1bffd2cc54c61797ba6636f94571c552b4009d6cf6da
6
+ metadata.gz: d1054505c8630377faab11beb693421a42c382bc7513934da4e53ae4c670085aafa35c98eb0b840d90305beccf3bd9c800015953bc77ab6abc5eb89211ff5e4f
7
+ data.tar.gz: 1c1d35d0bf0d4e85b66a7d3b56a09c2994d079b822fd479ff8fa0e08649255269b2093340a4f6f35a7959f1c6060cea9d9d429e4eeac4b94742c681179f4267d
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.120
1
+ 1.0.125
data/docs/api_key.md CHANGED
@@ -38,7 +38,6 @@
38
38
  ```
39
39
  Files::ApiKey.list(
40
40
  user_id: 1,
41
- page: 1,
42
41
  per_page: 1
43
42
  )
44
43
  ```
@@ -46,10 +45,8 @@ Files::ApiKey.list(
46
45
  ### Parameters
47
46
 
48
47
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
49
- * `page` (int64): Current page number.
48
+ * `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.
50
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
52
- * `cursor` (string): Send cursor 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.
53
50
  * `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 `deleted_at` and `expires_at`.
54
51
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
55
52
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
data/docs/app.md CHANGED
@@ -41,17 +41,14 @@
41
41
 
42
42
  ```
43
43
  Files::App.list(
44
- page: 1,
45
44
  per_page: 1
46
45
  )
47
46
  ```
48
47
 
49
48
  ### Parameters
50
49
 
51
- * `page` (int64): Current page number.
50
+ * `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.
52
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
53
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
54
- * `cursor` (string): Send cursor 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.
55
52
  * `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 `name` and `app_type`.
56
53
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
57
54
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
data/docs/as2_key.md CHANGED
@@ -26,7 +26,6 @@
26
26
  ```
27
27
  Files::As2Key.list(
28
28
  user_id: 1,
29
- page: 1,
30
29
  per_page: 1
31
30
  )
32
31
  ```
@@ -34,10 +33,8 @@ Files::As2Key.list(
34
33
  ### Parameters
35
34
 
36
35
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
- * `page` (int64): Current page number.
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.
38
37
  * `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
- * `cursor` (string): Send cursor 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.
41
38
 
42
39
 
43
40
  ---
data/docs/automation.md CHANGED
@@ -20,7 +20,20 @@
20
20
  ],
21
21
  "group_ids": [
22
22
 
23
- ]
23
+ ],
24
+ "trigger": "realtime",
25
+ "schedule": {
26
+ "days_of_week": [
27
+ 0,
28
+ 2,
29
+ 4
30
+ ],
31
+ "times_of_day": [
32
+ "6:30",
33
+ "14:30"
34
+ ],
35
+ "time_zone": "Eastern Time (US & Canada)"
36
+ }
24
37
  }
25
38
  ```
26
39
 
@@ -37,6 +50,8 @@
37
50
  * `user_id` (int64): User ID of the Automation's creator.
38
51
  * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
39
52
  * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
53
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
54
+ * `schedule` (object): Custom schedule description for when the automation should be run.
40
55
 
41
56
 
42
57
  ---
@@ -45,7 +60,6 @@
45
60
 
46
61
  ```
47
62
  Files::Automation.list(
48
- page: 1,
49
63
  per_page: 1,
50
64
  automation: "create_folder"
51
65
  )
@@ -53,10 +67,8 @@ Files::Automation.list(
53
67
 
54
68
  ### Parameters
55
69
 
56
- * `page` (int64): Current page number.
70
+ * `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.
57
71
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
59
- * `cursor` (string): Send cursor 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.
60
72
  * `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 `site_id` and `automation`.
61
73
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
62
74
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
@@ -89,13 +101,15 @@ Files::Automation.create(
89
101
  automation: "create_folder",
90
102
  source: "source",
91
103
  destination: "destination",
92
- interval: "year"
104
+ interval: "year",
105
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
106
+ trigger: "realtime"
93
107
  )
94
108
  ```
95
109
 
96
110
  ### Parameters
97
111
 
98
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
112
+ * `automation` (string): Required - Automation type
99
113
  * `source` (string): Source Path
100
114
  * `destination` (string): Destination Path
101
115
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -104,6 +118,8 @@ Files::Automation.create(
104
118
  * `path` (string): Path on which this Automation runs. Supports globs.
105
119
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
106
120
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
121
+ * `schedule` (object): Custom schedule for running this automation.
122
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
107
123
 
108
124
 
109
125
  ---
@@ -115,14 +131,16 @@ Files::Automation.update(id,
115
131
  automation: "create_folder",
116
132
  source: "source",
117
133
  destination: "destination",
118
- interval: "year"
134
+ interval: "year",
135
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
136
+ trigger: "realtime"
119
137
  )
120
138
  ```
121
139
 
122
140
  ### Parameters
123
141
 
124
142
  * `id` (int64): Required - Automation ID.
125
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
143
+ * `automation` (string): Required - Automation type
126
144
  * `source` (string): Source Path
127
145
  * `destination` (string): Destination Path
128
146
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -131,6 +149,8 @@ Files::Automation.update(id,
131
149
  * `path` (string): Path on which this Automation runs. Supports globs.
132
150
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
133
151
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
152
+ * `schedule` (object): Custom schedule for running this automation.
153
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
134
154
 
135
155
 
136
156
  ---
@@ -157,14 +177,16 @@ automation.update(
157
177
  automation: "create_folder",
158
178
  source: "source",
159
179
  destination: "destination",
160
- interval: "year"
180
+ interval: "year",
181
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
182
+ trigger: "realtime"
161
183
  )
162
184
  ```
163
185
 
164
186
  ### Parameters
165
187
 
166
188
  * `id` (int64): Required - Automation ID.
167
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
189
+ * `automation` (string): Required - Automation type
168
190
  * `source` (string): Source Path
169
191
  * `destination` (string): Destination Path
170
192
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -173,6 +195,8 @@ automation.update(
173
195
  * `path` (string): Path on which this Automation runs. Supports globs.
174
196
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
175
197
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
198
+ * `schedule` (object): Custom schedule for running this automation.
199
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
176
200
 
177
201
 
178
202
  ---
data/docs/bandwidth_snapshot.md CHANGED
@@ -33,17 +33,14 @@
33
33
 
34
34
  ```
35
35
  Files::BandwidthSnapshot.list(
36
- page: 1,
37
36
  per_page: 1
38
37
  )
39
38
  ```
40
39
 
41
40
  ### Parameters
42
41
 
43
- * `page` (int64): Current page number.
42
+ * `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
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
46
- * `cursor` (string): Send cursor 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.
47
44
  * `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 `site_id` and `logged_at`.
48
45
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
49
46
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
data/docs/behavior.md CHANGED
@@ -28,7 +28,6 @@
28
28
 
29
29
  ```
30
30
  Files::Behavior.list(
31
- page: 1,
32
31
  per_page: 1,
33
32
  behavior: "webhook"
34
33
  )
@@ -36,10 +35,8 @@ Files::Behavior.list(
36
35
 
37
36
  ### Parameters
38
37
 
39
- * `page` (int64): Current page number.
38
+ * `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.
40
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
42
- * `cursor` (string): Send cursor 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.
43
40
  * `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 `site_id` and `behavior`.
44
41
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
45
42
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
@@ -69,7 +66,6 @@ Files::Behavior.find(id)
69
66
 
70
67
  ```
71
68
  Files::Behavior.list_for(path,
72
- page: 1,
73
69
  per_page: 1,
74
70
  behavior: "webhook"
75
71
  )
@@ -77,10 +73,8 @@ Files::Behavior.list_for(path,
77
73
 
78
74
  ### Parameters
79
75
 
80
- * `page` (int64): Current page number.
76
+ * `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.
81
77
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
82
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
83
- * `cursor` (string): Send cursor 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.
84
78
  * `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 `site_id` and `behavior`.
85
79
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
86
80
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
data/docs/bundle.md CHANGED
@@ -55,7 +55,6 @@
55
55
  ```
56
56
  Files::Bundle.list(
57
57
  user_id: 1,
58
- page: 1,
59
58
  per_page: 1
60
59
  )
61
60
  ```
@@ -63,10 +62,8 @@ Files::Bundle.list(
63
62
  ### Parameters
64
63
 
65
64
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
66
- * `page` (int64): Current page number.
65
+ * `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.
67
66
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
68
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
69
- * `cursor` (string): Send cursor 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.
70
67
  * `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 `site_id`, `created_at` or `code`.
71
68
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
72
69
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
@@ -133,7 +130,8 @@ Files::Bundle.create(
133
130
  ```
134
131
  Files::Bundle.share(id,
135
132
  to: ["johndoe@gmail.com"],
136
- note: "Just a note."
133
+ note: "Just a note.",
134
+ recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
137
135
  )
138
136
  ```
139
137
 
@@ -142,6 +140,7 @@ Files::Bundle.share(id,
142
140
  * `id` (int64): Required - Bundle ID.
143
141
  * `to` (array(string)): Required - A list of email addresses to share this bundle with.
144
142
  * `note` (string): Note to include in email.
143
+ * `recipients` (array(object)): A list of recipients to share this bundle with.
145
144
 
146
145
 
147
146
  ---
@@ -150,6 +149,7 @@ Files::Bundle.share(id,
150
149
 
151
150
  ```
152
151
  Files::Bundle.update(id,
152
+ paths: ["file.txt"],
153
153
  password: "Password",
154
154
  clickwrap_id: 1,
155
155
  code: "abc123",
@@ -166,6 +166,7 @@ Files::Bundle.update(id,
166
166
  ### Parameters
167
167
 
168
168
  * `id` (int64): Required - Bundle ID.
169
+ * `paths` (array(string)): A list of paths to include in this bundle.
169
170
  * `password` (string): Password for this bundle.
170
171
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
171
172
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
@@ -200,7 +201,8 @@ bundle = Files::Bundle.list_for(path).first
200
201
 
201
202
  bundle.share(
202
203
  to: ["johndoe@gmail.com"],
203
- note: "Just a note."
204
+ note: "Just a note.",
205
+ recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
204
206
  )
205
207
  ```
206
208
 
@@ -209,6 +211,7 @@ bundle.share(
209
211
  * `id` (int64): Required - Bundle ID.
210
212
  * `to` (array(string)): Required - A list of email addresses to share this bundle with.
211
213
  * `note` (string): Note to include in email.
214
+ * `recipients` (array(object)): A list of recipients to share this bundle with.
212
215
 
213
216
 
214
217
  ---
@@ -219,6 +222,7 @@ bundle.share(
219
222
  bundle = Files::Bundle.list_for(path).first
220
223
 
221
224
  bundle.update(
225
+ paths: ["file.txt"],
222
226
  password: "Password",
223
227
  clickwrap_id: 1,
224
228
  code: "abc123",
@@ -235,6 +239,7 @@ bundle.update(
235
239
  ### Parameters
236
240
 
237
241
  * `id` (int64): Required - Bundle ID.
242
+ * `paths` (array(string)): A list of paths to include in this bundle.
238
243
  * `password` (string): Password for this bundle.
239
244
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
240
245
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
data/docs/bundle_download.md CHANGED
@@ -21,7 +21,6 @@
21
21
 
22
22
  ```
23
23
  Files::BundleDownload.list(
24
- page: 1,
25
24
  per_page: 1,
26
25
  bundle_registration_id: 1
27
26
  )
@@ -29,8 +28,6 @@ Files::BundleDownload.list(
29
28
 
30
29
  ### Parameters
31
30
 
32
- * `page` (int64): Current page number.
31
+ * `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.
33
32
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
35
- * `cursor` (string): Send cursor 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.
36
33
  * `bundle_registration_id` (int64): Required - BundleRegistration ID
data/docs/bundle_recipient.md CHANGED
@@ -26,7 +26,6 @@
26
26
  ```
27
27
  Files::BundleRecipient.list(
28
28
  user_id: 1,
29
- page: 1,
30
29
  per_page: 1,
31
30
  bundle_id: 1
32
31
  )
@@ -35,8 +34,6 @@ Files::BundleRecipient.list(
35
34
  ### Parameters
36
35
 
37
36
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
38
- * `page` (int64): Current page number.
37
+ * `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.
39
38
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
40
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
41
- * `cursor` (string): Send cursor 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.
42
39
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
data/docs/clickwrap.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
+ "id": 1,
7
8
  "name": "Example Site NDA for Files.com Use",
8
9
  "body": "[Legal body text]",
9
10
  "use_with_users": "",
@@ -12,12 +13,12 @@
12
13
  }
13
14
  ```
14
15
 
16
+ * `id` (int64): Clickwrap ID
15
17
  * `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
16
18
  * `body` (string): Body text of Clickwrap (supports Markdown formatting).
17
19
  * `use_with_users` (string): Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
18
20
  * `use_with_bundles` (string): Use this Clickwrap for Bundles?
19
21
  * `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
20
- * `id` (int64): Clickwrap ID.
21
22
 
22
23
 
23
24
  ---
@@ -26,17 +27,14 @@
26
27
 
27
28
  ```
28
29
  Files::Clickwrap.list(
29
- page: 1,
30
30
  per_page: 1
31
31
  )
32
32
  ```
33
33
 
34
34
  ### Parameters
35
35
 
36
- * `page` (int64): Current page number.
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
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
39
- * `cursor` (string): Send cursor 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.
40
38
 
41
39
 
42
40
  ---
data/docs/dns_record.md CHANGED
@@ -23,14 +23,11 @@
23
23
 
24
24
  ```
25
25
  Files::DnsRecord.list(
26
- page: 1,
27
26
  per_page: 1
28
27
  )
29
28
  ```
30
29
 
31
30
  ### Parameters
32
31
 
33
- * `page` (int64): Current page number.
32
+ * `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.
34
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
- * `cursor` (string): Send cursor 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.
data/docs/external_event.md CHANGED
@@ -23,17 +23,14 @@
23
23
 
24
24
  ```
25
25
  Files::ExternalEvent.list(
26
- page: 1,
27
26
  per_page: 1
28
27
  )
29
28
  ```
30
29
 
31
30
  ### Parameters
32
31
 
33
- * `page` (int64): Current page number.
32
+ * `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.
34
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
- * `cursor` (string): Send cursor 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
34
  * `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 `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
38
35
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
39
36
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.