files.com 1.1.82 → 1.1.84

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 (67) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account_line_item.md +2 -2
  4. data/docs/action.md +1 -1
  5. data/docs/api_key.md +2 -2
  6. data/docs/app.md +1 -1
  7. data/docs/as2_partner.md +2 -2
  8. data/docs/as2_station.md +2 -2
  9. data/docs/automation.md +10 -10
  10. data/docs/behavior.md +2 -2
  11. data/docs/bundle.md +5 -5
  12. data/docs/bundle_notification.md +2 -2
  13. data/docs/clickwrap.md +2 -2
  14. data/docs/errors.md +2 -2
  15. data/docs/file.md +6 -6
  16. data/docs/file_comment.md +1 -1
  17. data/docs/form_field.md +1 -1
  18. data/docs/form_field_set.md +4 -4
  19. data/docs/gpg_key.md +2 -2
  20. data/docs/group.md +2 -2
  21. data/docs/group_user.md +1 -1
  22. data/docs/history.md +1 -1
  23. data/docs/invoice.md +2 -2
  24. data/docs/ip_address.md +1 -1
  25. data/docs/message.md +3 -3
  26. data/docs/message_comment.md +3 -3
  27. data/docs/message_comment_reaction.md +1 -1
  28. data/docs/message_reaction.md +1 -1
  29. data/docs/notification.md +5 -5
  30. data/docs/payment.md +2 -2
  31. data/docs/project.md +2 -2
  32. data/docs/public_key.md +2 -2
  33. data/docs/remote_server.md +3 -3
  34. data/docs/settings_change.md +1 -1
  35. data/docs/sftp_host_key.md +2 -2
  36. data/docs/share_group.md +3 -3
  37. data/docs/site.md +2 -2
  38. data/docs/snapshot.md +3 -3
  39. data/docs/sso_strategy.md +1 -1
  40. data/docs/status.md +1 -1
  41. data/docs/style.md +2 -2
  42. data/docs/user.md +6 -6
  43. data/docs/user_request.md +1 -1
  44. data/lib/files.com/models/account_line_item.rb +2 -2
  45. data/lib/files.com/models/action.rb +1 -1
  46. data/lib/files.com/models/app.rb +1 -1
  47. data/lib/files.com/models/automation.rb +7 -7
  48. data/lib/files.com/models/bundle.rb +2 -2
  49. data/lib/files.com/models/errors.rb +2 -2
  50. data/lib/files.com/models/file_comment.rb +1 -1
  51. data/lib/files.com/models/form_field.rb +1 -1
  52. data/lib/files.com/models/form_field_set.rb +2 -2
  53. data/lib/files.com/models/group_user.rb +1 -1
  54. data/lib/files.com/models/history.rb +1 -1
  55. data/lib/files.com/models/invoice.rb +2 -2
  56. data/lib/files.com/models/ip_address.rb +1 -1
  57. data/lib/files.com/models/message.rb +1 -1
  58. data/lib/files.com/models/message_comment.rb +1 -1
  59. data/lib/files.com/models/notification.rb +3 -3
  60. data/lib/files.com/models/payment.rb +2 -2
  61. data/lib/files.com/models/settings_change.rb +1 -1
  62. data/lib/files.com/models/share_group.rb +1 -1
  63. data/lib/files.com/models/site.rb +2 -2
  64. data/lib/files.com/models/status.rb +1 -1
  65. data/lib/files.com/models/user.rb +1 -1
  66. data/lib/files.com/version.rb +1 -1
  67. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4d4e66c22b0d20c44a7a53a0466ccae5c927825524f8e70da5f23c5df93d537a
4
- data.tar.gz: 667d274d4b29e015316f7f2541d55cc2ac415ead6a61104e288d738b1210782a
3
+ metadata.gz: cb18f4bd2662332742f3c44e06dedd3336c788011b29d9ba49e7c37236f48cc0
4
+ data.tar.gz: 21141ce64d37a240682f8b39477c9358e041c720c5e173b3d0eb08cc313f230c
5
5
  SHA512:
6
- metadata.gz: 54d0b03228a45ce0e591ea5e5f43410ecf4f455462d4e46678e95b292bcbe335494cda075481e9e4b3ecc068c218c8769a18e8314a5fe02c1bb739b4fb1be0f2
7
- data.tar.gz: 3cb4ad86e39f8044a66061caf4709db0bf6fb540d442276cfa7c692be9e306c0d306797ebcdc4ec80345b9936bf4228c424e05f4deba195bcc77f81cd78330b1
6
+ metadata.gz: eecbe66798bef98c8cb3a810bc71d5c1989aae243d1e8768cfe8196c2427a8b88ac366c744d341e7b50b807757b45afb5baef23e366f9a0094431bdc3c801a11
7
+ data.tar.gz: 1b7820e175b7a7dd25406e1c2c56ff173d2540a239299753939715d2411a5e74d4a8b06584608b1b176523e6e2f0160ac37d2a015f5cfa9d670da74c1c0496ed
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.82
1
+ 1.1.84
@@ -44,9 +44,9 @@
44
44
  * `created_at` (date-time): Line item created at
45
45
  * `currency` (string): Line item currency
46
46
  * `download_uri` (string): Line item download uri
47
- * `invoice_line_items` (array): Associated invoice line items
47
+ * `invoice_line_items` (array(object)): Associated invoice line items
48
48
  * `method` (string): Line item payment method
49
- * `payment_line_items` (array): Associated payment line items
49
+ * `payment_line_items` (array(object)): Associated payment line items
50
50
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
51
51
  * `payment_type` (string): Type of payment if applicable
52
52
  * `site_name` (string): Site name this line item is for
data/docs/action.md CHANGED
@@ -29,7 +29,7 @@
29
29
  * `display` (string): Friendly displayed output
30
30
  * `ip` (string): IP Address that performed this action
31
31
  * `source` (string): The source path for this action, if applicable
32
- * `targets` (array): Targets
32
+ * `targets` (array(object)): Targets
33
33
  * `user_id` (int64): User ID
34
34
  * `username` (string): Username
35
35
  * `action` (string): Type of action
data/docs/api_key.md CHANGED
@@ -170,7 +170,7 @@ Files::ApiKey.delete(id)
170
170
  ## Update Api Key
171
171
 
172
172
  ```
173
- api_key = Files::ApiKey.list.first
173
+ api_key = Files::ApiKey.find(id)
174
174
 
175
175
  api_key.update(
176
176
  description: "example",
@@ -194,7 +194,7 @@ api_key.update(
194
194
  ## Delete Api Key
195
195
 
196
196
  ```
197
- api_key = Files::ApiKey.list.first
197
+ api_key = Files::ApiKey.find(id)
198
198
 
199
199
  api_key.delete
200
200
  ```
data/docs/app.md CHANGED
@@ -46,7 +46,7 @@
46
46
  * `name` (string): Name of the App
47
47
  * `package_manager_install_command` (string): Package manager install command
48
48
  * `remote_server_type` (string): Associated Remote Server type, if any
49
- * `screenshot_list_urls` (array): Screenshots of the App
49
+ * `screenshot_list_urls` (array(string)): Screenshots of the App
50
50
  * `sdk_installation_instructions_link` (string): Link to SDK installation instructions
51
51
  * `short_description` (string): Short description of the App
52
52
  * `sso_strategy_type` (string): Associated SSO Strategy type, if any
data/docs/as2_partner.md CHANGED
@@ -137,7 +137,7 @@ Files::As2Partner.delete(id)
137
137
  ## Update As2 Partner
138
138
 
139
139
  ```
140
- as2_partner = Files::As2Partner.list.first
140
+ as2_partner = Files::As2Partner.find(id)
141
141
 
142
142
  as2_partner.update(
143
143
  name: "AS2 Partner Name",
@@ -164,7 +164,7 @@ as2_partner.update(
164
164
  ## Delete As2 Partner
165
165
 
166
166
  ```
167
- as2_partner = Files::As2Partner.list.first
167
+ as2_partner = Files::As2Partner.find(id)
168
168
 
169
169
  as2_partner.delete
170
170
  ```
data/docs/as2_station.md CHANGED
@@ -124,7 +124,7 @@ Files::As2Station.delete(id)
124
124
  ## Update As2 Station
125
125
 
126
126
  ```
127
- as2_station = Files::As2Station.list.first
127
+ as2_station = Files::As2Station.find(id)
128
128
 
129
129
  as2_station.update(
130
130
  name: "AS2 Station Name"
@@ -145,7 +145,7 @@ as2_station.update(
145
145
  ## Delete As2 Station
146
146
 
147
147
  ```
148
- as2_station = Files::As2Station.list.first
148
+ as2_station = Files::As2Station.find(id)
149
149
 
150
150
  as2_station.delete
151
151
  ```
data/docs/automation.md CHANGED
@@ -68,10 +68,10 @@
68
68
  * `description` (string): Description for the this Automation.
69
69
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
70
70
  * `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.
71
- * `destinations` (array): Destination Paths
71
+ * `destinations` (array(string)): Destination Paths
72
72
  * `disabled` (boolean): If true, this automation will not run.
73
73
  * `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
74
- * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
74
+ * `group_ids` (array(int64)): IDs of Groups for the Automation (i.e. who to Request File from)
75
75
  * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
76
76
  * `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
77
77
  * `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
@@ -82,15 +82,15 @@
82
82
  * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
83
83
  * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
84
84
  * `human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
85
- * `schedule_days_of_week` (array): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
86
- * `schedule_times_of_day` (array): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
85
+ * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
86
+ * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
87
87
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
88
88
  * `source` (string): Source Path
89
- * `sync_ids` (array): IDs of remote sync folder behaviors to run by this Automation
90
- * `trigger_actions` (array): 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
89
+ * `sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
90
+ * `trigger_actions` (array(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
91
91
  * `trigger` (string): How this automation is triggered to run.
92
92
  * `user_id` (int64): User ID of the Automation's creator.
93
- * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
93
+ * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
94
94
  * `value` (object): A Hash of attributes specific to the automation type.
95
95
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
96
96
  * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
@@ -293,7 +293,7 @@ Files::Automation.delete(id)
293
293
  ## Manually run automation
294
294
 
295
295
  ```
296
- automation = Files::Automation.list.first
296
+ automation = Files::Automation.find(id)
297
297
 
298
298
  automation.manual_run
299
299
  ```
@@ -308,7 +308,7 @@ automation.manual_run
308
308
  ## Update Automation
309
309
 
310
310
  ```
311
- automation = Files::Automation.list.first
311
+ automation = Files::Automation.find(id)
312
312
 
313
313
  automation.update(
314
314
  source: "source",
@@ -375,7 +375,7 @@ automation.update(
375
375
  ## Delete Automation
376
376
 
377
377
  ```
378
- automation = Files::Automation.list.first
378
+ automation = Files::Automation.find(id)
379
379
 
380
380
  automation.delete
381
381
  ```
data/docs/behavior.md CHANGED
@@ -188,7 +188,7 @@ Files::Behavior.delete(id)
188
188
  ## Update Behavior
189
189
 
190
190
  ```
191
- behavior = Files::Behavior.list.first
191
+ behavior = Files::Behavior.find(id)
192
192
 
193
193
  behavior.update(
194
194
  value: "{\"method\": \"GET\"}",
@@ -221,7 +221,7 @@ behavior.update(
221
221
  ## Delete Behavior
222
222
 
223
223
  ```
224
- behavior = Files::Behavior.list.first
224
+ behavior = Files::Behavior.find(id)
225
225
 
226
226
  behavior.delete
227
227
  ```
data/docs/bundle.md CHANGED
@@ -123,8 +123,8 @@
123
123
  * `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
124
124
  * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
125
125
  * `has_inbox` (boolean): Does this bundle have an associated inbox?
126
- * `paths` (array): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
127
- * `bundlepaths` (array): A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
126
+ * `paths` (array(string)): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
127
+ * `bundlepaths` (array(object)): A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
128
128
  * `password` (string): Password for this bundle.
129
129
  * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
130
130
  * `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
@@ -339,7 +339,7 @@ Files::Bundle.delete(id)
339
339
  ## Send email(s) with a link to bundle
340
340
 
341
341
  ```
342
- bundle = Files::Bundle.list.first
342
+ bundle = Files::Bundle.find(id)
343
343
 
344
344
  bundle.share(
345
345
  to: ["johndoe@gmail.com"],
@@ -361,7 +361,7 @@ bundle.share(
361
361
  ## Update Bundle
362
362
 
363
363
  ```
364
- bundle = Files::Bundle.list.first
364
+ bundle = Files::Bundle.find(id)
365
365
 
366
366
  bundle.update(
367
367
  paths: ["file.txt"],
@@ -428,7 +428,7 @@ bundle.update(
428
428
  ## Delete Bundle
429
429
 
430
430
  ```
431
- bundle = Files::Bundle.list.first
431
+ bundle = Files::Bundle.find(id)
432
432
 
433
433
  bundle.delete
434
434
  ```
@@ -107,7 +107,7 @@ Files::BundleNotification.delete(id)
107
107
  ## Update Bundle Notification
108
108
 
109
109
  ```
110
- bundle_notification = Files::BundleNotification.list.first
110
+ bundle_notification = Files::BundleNotification.find(id)
111
111
 
112
112
  bundle_notification.update(
113
113
  notify_on_registration: true,
@@ -127,7 +127,7 @@ bundle_notification.update(
127
127
  ## Delete Bundle Notification
128
128
 
129
129
  ```
130
- bundle_notification = Files::BundleNotification.list.first
130
+ bundle_notification = Files::BundleNotification.find(id)
131
131
 
132
132
  bundle_notification.delete
133
133
  ```
data/docs/clickwrap.md CHANGED
@@ -115,7 +115,7 @@ Files::Clickwrap.delete(id)
115
115
  ## Update Clickwrap
116
116
 
117
117
  ```
118
- clickwrap = Files::Clickwrap.list.first
118
+ clickwrap = Files::Clickwrap.find(id)
119
119
 
120
120
  clickwrap.update(
121
121
  name: "Example Site NDA for Files.com Use",
@@ -141,7 +141,7 @@ clickwrap.update(
141
141
  ## Delete Clickwrap
142
142
 
143
143
  ```
144
- clickwrap = Files::Clickwrap.list.first
144
+ clickwrap = Files::Clickwrap.find(id)
145
145
 
146
146
  clickwrap.delete
147
147
  ```
data/docs/errors.md CHANGED
@@ -13,5 +13,5 @@
13
13
  }
14
14
  ```
15
15
 
16
- * `fields` (array): A list of fields where errors occur
17
- * `messages` (array): A list of error messages
16
+ * `fields` (array(string)): A list of fields where errors occur
17
+ * `messages` (array(string)): A list of error messages
data/docs/file.md CHANGED
@@ -276,7 +276,7 @@ Files::File.begin_upload(path,
276
276
  ## Download file
277
277
 
278
278
  ```
279
- file = Files::File.new
279
+ file = Files::File.find(path)
280
280
 
281
281
  file.download(
282
282
  with_previews: true,
@@ -298,7 +298,7 @@ file.download(
298
298
  ## Update file/folder metadata
299
299
 
300
300
  ```
301
- file = Files::File.new
301
+ file = Files::File.find(path)
302
302
 
303
303
  file.update(
304
304
  custom_metadata: {"key":"value"},
@@ -320,7 +320,7 @@ file.update(
320
320
  ## Delete file/folder
321
321
 
322
322
  ```
323
- file = Files::File.new
323
+ file = Files::File.find(path)
324
324
 
325
325
  file.delete(
326
326
  recursive: true
@@ -338,7 +338,7 @@ file.delete(
338
338
  ## Copy file/folder
339
339
 
340
340
  ```
341
- file = Files::File.new
341
+ file = Files::File.find(path)
342
342
 
343
343
  file.copy(
344
344
  destination: "destination",
@@ -360,7 +360,7 @@ file.copy(
360
360
  ## Move file/folder
361
361
 
362
362
  ```
363
- file = Files::File.new
363
+ file = Files::File.find(path)
364
364
 
365
365
  file.move(
366
366
  destination: "destination",
@@ -380,7 +380,7 @@ file.move(
380
380
  ## Begin file upload
381
381
 
382
382
  ```
383
- file = Files::File.new
383
+ file = Files::File.find(path)
384
384
 
385
385
  file.begin_upload(
386
386
  mkdir_parents: true,
data/docs/file_comment.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  * `id` (int64): File Comment ID
19
19
  * `body` (string): Comment body.
20
- * `reactions` (array): Reactions to this comment.
20
+ * `reactions` (array(object)): Reactions to this comment.
21
21
  * `path` (string): File path.
22
22
 
23
23
 
data/docs/form_field.md CHANGED
@@ -24,6 +24,6 @@
24
24
  * `required` (boolean): Is this a required field?
25
25
  * `help_text` (string): Help text to be displayed
26
26
  * `field_type` (string): Type of Field
27
- * `options_for_select` (array): Options to display for radio and dropdown
27
+ * `options_for_select` (array(string)): Options to display for radio and dropdown
28
28
  * `default_option` (string): Default option for radio and dropdown
29
29
  * `form_field_set_id` (int64): Form field set id
@@ -36,8 +36,8 @@
36
36
 
37
37
  * `id` (int64): Form field set id
38
38
  * `title` (string): Title to be displayed
39
- * `form_layout` (array): Layout of the form
40
- * `form_fields` (array): Associated form fields
39
+ * `form_layout` (array(int64)): Layout of the form
40
+ * `form_fields` (array(object)): Associated form fields
41
41
  * `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
42
42
  * `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
43
43
  * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
@@ -142,7 +142,7 @@ Files::FormFieldSet.delete(id)
142
142
  ## Update Form Field Set
143
143
 
144
144
  ```
145
- form_field_set = Files::FormFieldSet.list.first
145
+ form_field_set = Files::FormFieldSet.find(id)
146
146
 
147
147
  form_field_set.update(
148
148
  title: "Sample Form Title",
@@ -168,7 +168,7 @@ form_field_set.update(
168
168
  ## Delete Form Field Set
169
169
 
170
170
  ```
171
- form_field_set = Files::FormFieldSet.list.first
171
+ form_field_set = Files::FormFieldSet.find(id)
172
172
 
173
173
  form_field_set.delete
174
174
  ```
data/docs/gpg_key.md CHANGED
@@ -118,7 +118,7 @@ Files::GpgKey.delete(id)
118
118
  ## Update Gpg Key
119
119
 
120
120
  ```
121
- gpg_key = Files::GpgKey.list.first
121
+ gpg_key = Files::GpgKey.find(id)
122
122
 
123
123
  gpg_key.update(
124
124
  public_key: "7f8bc1210b09b9ddf469e6b6b8920e76",
@@ -142,7 +142,7 @@ gpg_key.update(
142
142
  ## Delete Gpg Key
143
143
 
144
144
  ```
145
- gpg_key = Files::GpgKey.list.first
145
+ gpg_key = Files::GpgKey.find(id)
146
146
 
147
147
  gpg_key.delete
148
148
  ```
data/docs/group.md CHANGED
@@ -145,7 +145,7 @@ Files::Group.delete(id)
145
145
  ## Update Group
146
146
 
147
147
  ```
148
- group = Files::Group.list.first
148
+ group = Files::Group.find(id)
149
149
 
150
150
  group.update(
151
151
  notes: "example",
@@ -179,7 +179,7 @@ group.update(
179
179
  ## Delete Group
180
180
 
181
181
  ```
182
- group = Files::Group.list.first
182
+ group = Files::Group.find(id)
183
183
 
184
184
  group.delete
185
185
  ```
data/docs/group_user.md CHANGED
@@ -18,7 +18,7 @@
18
18
  * `group_id` (int64): Group ID
19
19
  * `user_id` (int64): User ID
20
20
  * `admin` (boolean): Is this user an administrator of this group?
21
- * `usernames` (array): A list of usernames for users in this group
21
+ * `usernames` (array(string)): A list of usernames for users in this group
22
22
  * `id` (int64): Group User ID.
23
23
 
24
24
 
data/docs/history.md CHANGED
@@ -29,7 +29,7 @@
29
29
  * `display` (string): Friendly displayed output
30
30
  * `ip` (string): IP Address that performed this action
31
31
  * `source` (string): The source path for this action, if applicable
32
- * `targets` (array): Targets
32
+ * `targets` (array(object)): Targets
33
33
  * `user_id` (int64): User ID
34
34
  * `username` (string): Username
35
35
  * `action` (string): Type of action
data/docs/invoice.md CHANGED
@@ -44,9 +44,9 @@
44
44
  * `created_at` (date-time): Line item created at
45
45
  * `currency` (string): Line item currency
46
46
  * `download_uri` (string): Line item download uri
47
- * `invoice_line_items` (array): Associated invoice line items
47
+ * `invoice_line_items` (array(object)): Associated invoice line items
48
48
  * `method` (string): Line item payment method
49
- * `payment_line_items` (array): Associated payment line items
49
+ * `payment_line_items` (array(object)): Associated payment line items
50
50
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
51
51
  * `payment_type` (string): Type of payment if applicable
52
52
  * `site_name` (string): Site name this line item is for
data/docs/ip_address.md CHANGED
@@ -16,7 +16,7 @@
16
16
  * `id` (string): Unique label for list; used by Zapier and other integrations.
17
17
  * `associated_with` (string): The object that this public IP address list is associated with.
18
18
  * `group_id` (int64): Group ID
19
- * `ip_addresses` (array): A list of IP addresses.
19
+ * `ip_addresses` (array(string)): A list of IP addresses.
20
20
 
21
21
 
22
22
  ---
data/docs/message.md CHANGED
@@ -25,7 +25,7 @@
25
25
  * `id` (int64): Message ID
26
26
  * `subject` (string): Message subject.
27
27
  * `body` (string): Message body.
28
- * `comments` (array): Comments.
28
+ * `comments` (array(object)): Comments.
29
29
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
30
30
  * `project_id` (int64): Project to which the message should be attached.
31
31
 
@@ -122,7 +122,7 @@ Files::Message.delete(id)
122
122
  ## Update Message
123
123
 
124
124
  ```
125
- message = Files::Message.list.first
125
+ message = Files::Message.find(id)
126
126
 
127
127
  message.update(
128
128
  project_id: 1,
@@ -144,7 +144,7 @@ message.update(
144
144
  ## Delete Message
145
145
 
146
146
  ```
147
- message = Files::Message.list.first
147
+ message = Files::Message.find(id)
148
148
 
149
149
  message.delete
150
150
  ```
@@ -17,7 +17,7 @@
17
17
 
18
18
  * `id` (int64): Message Comment ID
19
19
  * `body` (string): Comment body.
20
- * `reactions` (array): Reactions to this comment.
20
+ * `reactions` (array(object)): Reactions to this comment.
21
21
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
22
22
 
23
23
 
@@ -105,7 +105,7 @@ Files::MessageComment.delete(id)
105
105
  ## Update Message Comment
106
106
 
107
107
  ```
108
- message_comment = Files::MessageComment.list.first
108
+ message_comment = Files::MessageComment.find(id)
109
109
 
110
110
  message_comment.update(
111
111
  body: "body"
@@ -123,7 +123,7 @@ message_comment.update(
123
123
  ## Delete Message Comment
124
124
 
125
125
  ```
126
- message_comment = Files::MessageComment.list.first
126
+ message_comment = Files::MessageComment.find(id)
127
127
 
128
128
  message_comment.delete
129
129
  ```
@@ -82,7 +82,7 @@ Files::MessageCommentReaction.delete(id)
82
82
  ## Delete Message Comment Reaction
83
83
 
84
84
  ```
85
- message_comment_reaction = Files::MessageCommentReaction.list.first
85
+ message_comment_reaction = Files::MessageCommentReaction.find(id)
86
86
 
87
87
  message_comment_reaction.delete
88
88
  ```
@@ -82,7 +82,7 @@ Files::MessageReaction.delete(id)
82
82
  ## Delete Message Reaction
83
83
 
84
84
  ```
85
- message_reaction = Files::MessageReaction.list.first
85
+ message_reaction = Files::MessageReaction.find(id)
86
86
 
87
87
  message_reaction.delete
88
88
  ```
data/docs/notification.md CHANGED
@@ -40,8 +40,8 @@
40
40
  * `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.
41
41
  * `group_id` (int64): ID of Group to receive notifications
42
42
  * `group_name` (string): Group name, if a Group ID is set
43
- * `triggering_group_ids` (array): If set, will only notify on actions made by a member of one of the specified groups
44
- * `triggering_user_ids` (array): If set, will onlynotify on actions made one of the specified users
43
+ * `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
44
+ * `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
45
45
  * `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
46
46
  * `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
47
47
  * `notify_on_copy` (boolean): Trigger on files copied to this path?
@@ -52,7 +52,7 @@
52
52
  * `recursive` (boolean): Apply notification recursively? This will enable notifications for each subfolder.
53
53
  * `send_interval` (string): The time interval that notifications are aggregated to
54
54
  * `message` (string): Custom message to include in notification emails
55
- * `triggering_filenames` (array): Array of filenames (possibly with wildcards) to scope trigger
55
+ * `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
56
56
  * `unsubscribed` (boolean): Is the user unsubscribed from this notification?
57
57
  * `unsubscribed_reason` (string): The reason that the user unsubscribed
58
58
  * `user_id` (int64): Notification user ID
@@ -203,7 +203,7 @@ Files::Notification.delete(id)
203
203
  ## Update Notification
204
204
 
205
205
  ```
206
- notification = Files::Notification.list.first
206
+ notification = Files::Notification.find(id)
207
207
 
208
208
  notification.update(
209
209
  notify_on_copy: true,
@@ -245,7 +245,7 @@ notification.update(
245
245
  ## Delete Notification
246
246
 
247
247
  ```
248
- notification = Files::Notification.list.first
248
+ notification = Files::Notification.find(id)
249
249
 
250
250
  notification.delete
251
251
  ```
data/docs/payment.md CHANGED
@@ -44,9 +44,9 @@
44
44
  * `created_at` (date-time): Line item created at
45
45
  * `currency` (string): Line item currency
46
46
  * `download_uri` (string): Line item download uri
47
- * `invoice_line_items` (array): Associated invoice line items
47
+ * `invoice_line_items` (array(object)): Associated invoice line items
48
48
  * `method` (string): Line item payment method
49
- * `payment_line_items` (array): Associated payment line items
49
+ * `payment_line_items` (array(object)): Associated payment line items
50
50
  * `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
51
51
  * `payment_type` (string): Type of payment if applicable
52
52
  * `site_name` (string): Site name this line item is for
data/docs/project.md CHANGED
@@ -91,7 +91,7 @@ Files::Project.delete(id)
91
91
  ## Update Project
92
92
 
93
93
  ```
94
- project = Files::Project.list.first
94
+ project = Files::Project.find(id)
95
95
 
96
96
  project.update(
97
97
  global_access: "global_access"
@@ -109,7 +109,7 @@ project.update(
109
109
  ## Delete Project
110
110
 
111
111
  ```
112
- project = Files::Project.list.first
112
+ project = Files::Project.find(id)
113
113
 
114
114
  project.delete
115
115
  ```
data/docs/public_key.md CHANGED
@@ -108,7 +108,7 @@ Files::PublicKey.delete(id)
108
108
  ## Update Public Key
109
109
 
110
110
  ```
111
- public_key = Files::PublicKey.list.first
111
+ public_key = Files::PublicKey.find(id)
112
112
 
113
113
  public_key.update(
114
114
  title: "My Main Key"
@@ -126,7 +126,7 @@ public_key.update(
126
126
  ## Delete Public Key
127
127
 
128
128
  ```
129
- public_key = Files::PublicKey.list.first
129
+ public_key = Files::PublicKey.find(id)
130
130
 
131
131
  public_key.delete
132
132
  ```
@@ -482,7 +482,7 @@ Files::RemoteServer.delete(id)
482
482
  ## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
483
483
 
484
484
  ```
485
- remote_server = Files::RemoteServer.list.first
485
+ remote_server = Files::RemoteServer.find(id)
486
486
 
487
487
  remote_server.configuration_file(
488
488
  api_token: "example",
@@ -520,7 +520,7 @@ remote_server.configuration_file(
520
520
  ## Update Remote Server
521
521
 
522
522
  ```
523
- remote_server = Files::RemoteServer.list.first
523
+ remote_server = Files::RemoteServer.find(id)
524
524
 
525
525
  remote_server.update(
526
526
  aws_access_key: "example",
@@ -647,7 +647,7 @@ remote_server.update(
647
647
  ## Delete Remote Server
648
648
 
649
649
  ```
650
- remote_server = Files::RemoteServer.list.first
650
+ remote_server = Files::RemoteServer.find(id)
651
651
 
652
652
  remote_server.delete
653
653
  ```
@@ -15,7 +15,7 @@
15
15
  }
16
16
  ```
17
17
 
18
- * `changes` (array): Markdown-formatted change messages.
18
+ * `changes` (array(string)): Markdown-formatted change messages.
19
19
  * `created_at` (date-time): The time this change was made
20
20
  * `user_id` (int64): The user id responsible for this change
21
21
  * `api_key_id` (int64): The api key id responsible for this change