files.com 1.0.248 → 1.0.250

Sign up to get free protection for your applications and to get access to all the features.
Files changed (81) hide show
  1. package/_VERSION +1 -1
  2. package/docs/models/Site.md +4 -0
  3. package/lib/models/AccountLineItem.js +14 -0
  4. package/lib/models/Action.js +13 -0
  5. package/lib/models/ActionNotificationExport.js +27 -0
  6. package/lib/models/ActionNotificationExportResult.js +15 -0
  7. package/lib/models/ActionWebhookFailure.js +1 -0
  8. package/lib/models/ApiKey.js +42 -0
  9. package/lib/models/App.js +26 -0
  10. package/lib/models/As2IncomingMessage.js +46 -0
  11. package/lib/models/As2OutgoingMessage.js +42 -0
  12. package/lib/models/As2Partner.js +29 -0
  13. package/lib/models/As2Station.js +31 -0
  14. package/lib/models/Auto.js +1 -0
  15. package/lib/models/Automation.js +72 -0
  16. package/lib/models/AutomationRun.js +20 -0
  17. package/lib/models/BandwidthSnapshot.js +19 -0
  18. package/lib/models/Behavior.js +57 -0
  19. package/lib/models/Bundle.js +98 -0
  20. package/lib/models/BundleDownload.js +16 -0
  21. package/lib/models/BundleNotification.js +20 -0
  22. package/lib/models/BundleRecipient.js +28 -0
  23. package/lib/models/BundleRegistration.js +18 -0
  24. package/lib/models/Clickwrap.js +23 -0
  25. package/lib/models/DnsRecord.js +7 -0
  26. package/lib/models/Errors.js +2 -0
  27. package/lib/models/ExternalEvent.js +26 -0
  28. package/lib/models/File.js +88 -0
  29. package/lib/models/FileAction.js +2 -0
  30. package/lib/models/FileComment.js +13 -0
  31. package/lib/models/FileCommentReaction.js +8 -0
  32. package/lib/models/FileMigration.js +11 -0
  33. package/lib/models/FileUploadPart.js +15 -0
  34. package/lib/models/Folder.js +33 -0
  35. package/lib/models/FormField.js +8 -0
  36. package/lib/models/FormFieldSet.js +27 -0
  37. package/lib/models/Group.js +29 -0
  38. package/lib/models/GroupUser.js +22 -0
  39. package/lib/models/History.js +57 -0
  40. package/lib/models/HistoryExport.js +51 -0
  41. package/lib/models/HistoryExportResult.js +29 -0
  42. package/lib/models/Image.js +2 -0
  43. package/lib/models/InboxRecipient.js +28 -0
  44. package/lib/models/InboxRegistration.js +15 -0
  45. package/lib/models/InboxUpload.js +15 -0
  46. package/lib/models/Invoice.js +19 -0
  47. package/lib/models/InvoiceLineItem.js +9 -0
  48. package/lib/models/IpAddress.js +13 -0
  49. package/lib/models/Lock.js +25 -0
  50. package/lib/models/Message.js +22 -0
  51. package/lib/models/MessageComment.js +16 -0
  52. package/lib/models/MessageCommentReaction.js +13 -0
  53. package/lib/models/MessageReaction.js +13 -0
  54. package/lib/models/Notification.js +70 -0
  55. package/lib/models/Payment.js +19 -0
  56. package/lib/models/PaymentLineItem.js +4 -0
  57. package/lib/models/Permission.js +29 -0
  58. package/lib/models/Preview.js +5 -0
  59. package/lib/models/Priority.js +6 -0
  60. package/lib/models/Project.js +11 -0
  61. package/lib/models/PublicIpAddress.js +4 -0
  62. package/lib/models/PublicKey.js +18 -0
  63. package/lib/models/RemoteBandwidthSnapshot.js +15 -0
  64. package/lib/models/RemoteServer.js +194 -0
  65. package/lib/models/RemoteServerConfigurationFile.js +12 -0
  66. package/lib/models/Request.js +25 -0
  67. package/lib/models/Session.js +13 -0
  68. package/lib/models/SettingsChange.js +15 -0
  69. package/lib/models/SftpHostKey.js +16 -0
  70. package/lib/models/Site.js +281 -0
  71. package/lib/models/SsoStrategy.js +49 -0
  72. package/lib/models/Status.js +7 -0
  73. package/lib/models/Style.js +9 -0
  74. package/lib/models/UsageDailySnapshot.js +21 -0
  75. package/lib/models/UsageSnapshot.js +18 -0
  76. package/lib/models/User.js +183 -0
  77. package/lib/models/UserCipherUse.js +10 -0
  78. package/lib/models/UserRequest.js +13 -0
  79. package/lib/models/WebhookTest.js +24 -0
  80. package/package.json +1 -1
  81. package/src/models/Site.js +4 -0
@@ -31,138 +31,174 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Notification ID
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
37
38
  (0, _defineProperty2.default)(this, "setId", function (value) {
38
39
  _this.attributes.id = value;
39
40
  });
41
+ // 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.
40
42
  (0, _defineProperty2.default)(this, "getPath", function () {
41
43
  return _this.attributes.path;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setPath", function (value) {
44
46
  _this.attributes.path = value;
45
47
  });
48
+ // int64 # Notification group id
46
49
  (0, _defineProperty2.default)(this, "getGroupId", function () {
47
50
  return _this.attributes.group_id;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setGroupId", function (value) {
50
53
  _this.attributes.group_id = value;
51
54
  });
55
+ // string # Group name if applicable
52
56
  (0, _defineProperty2.default)(this, "getGroupName", function () {
53
57
  return _this.attributes.group_name;
54
58
  });
55
59
  (0, _defineProperty2.default)(this, "setGroupName", function (value) {
56
60
  _this.attributes.group_name = value;
57
61
  });
62
+ // array # Only notify on actions made by a member of one of the specified groups
58
63
  (0, _defineProperty2.default)(this, "getTriggeringGroupIds", function () {
59
64
  return _this.attributes.triggering_group_ids;
60
65
  });
61
66
  (0, _defineProperty2.default)(this, "setTriggeringGroupIds", function (value) {
62
67
  _this.attributes.triggering_group_ids = value;
63
68
  });
69
+ // array # Only notify on actions made one of the specified users
64
70
  (0, _defineProperty2.default)(this, "getTriggeringUserIds", function () {
65
71
  return _this.attributes.triggering_user_ids;
66
72
  });
67
73
  (0, _defineProperty2.default)(this, "setTriggeringUserIds", function (value) {
68
74
  _this.attributes.triggering_user_ids = value;
69
75
  });
76
+ // boolean # Notify when actions are performed by a share recipient?
70
77
  (0, _defineProperty2.default)(this, "getTriggerByShareRecipients", function () {
71
78
  return _this.attributes.trigger_by_share_recipients;
72
79
  });
73
80
  (0, _defineProperty2.default)(this, "setTriggerByShareRecipients", function (value) {
74
81
  _this.attributes.trigger_by_share_recipients = value;
75
82
  });
83
+ // boolean # Trigger notification on notification user actions?
76
84
  (0, _defineProperty2.default)(this, "getNotifyUserActions", function () {
77
85
  return _this.attributes.notify_user_actions;
78
86
  });
79
87
  (0, _defineProperty2.default)(this, "setNotifyUserActions", function (value) {
80
88
  _this.attributes.notify_user_actions = value;
81
89
  });
90
+ // boolean # Triggers notification when copying files to this path
82
91
  (0, _defineProperty2.default)(this, "getNotifyOnCopy", function () {
83
92
  return _this.attributes.notify_on_copy;
84
93
  });
85
94
  (0, _defineProperty2.default)(this, "setNotifyOnCopy", function (value) {
86
95
  _this.attributes.notify_on_copy = value;
87
96
  });
97
+ // boolean # Triggers notification when deleting files from this path
88
98
  (0, _defineProperty2.default)(this, "getNotifyOnDelete", function () {
89
99
  return _this.attributes.notify_on_delete;
90
100
  });
91
101
  (0, _defineProperty2.default)(this, "setNotifyOnDelete", function (value) {
92
102
  _this.attributes.notify_on_delete = value;
93
103
  });
104
+ // boolean # Triggers notification when downloading files from this path
94
105
  (0, _defineProperty2.default)(this, "getNotifyOnDownload", function () {
95
106
  return _this.attributes.notify_on_download;
96
107
  });
97
108
  (0, _defineProperty2.default)(this, "setNotifyOnDownload", function (value) {
98
109
  _this.attributes.notify_on_download = value;
99
110
  });
111
+ // boolean # Triggers notification when moving files to this path
100
112
  (0, _defineProperty2.default)(this, "getNotifyOnMove", function () {
101
113
  return _this.attributes.notify_on_move;
102
114
  });
103
115
  (0, _defineProperty2.default)(this, "setNotifyOnMove", function (value) {
104
116
  _this.attributes.notify_on_move = value;
105
117
  });
118
+ // boolean # Triggers notification when uploading new files to this path
106
119
  (0, _defineProperty2.default)(this, "getNotifyOnUpload", function () {
107
120
  return _this.attributes.notify_on_upload;
108
121
  });
109
122
  (0, _defineProperty2.default)(this, "setNotifyOnUpload", function (value) {
110
123
  _this.attributes.notify_on_upload = value;
111
124
  });
125
+ // boolean # Enable notifications for each subfolder in this path
112
126
  (0, _defineProperty2.default)(this, "getRecursive", function () {
113
127
  return _this.attributes.recursive;
114
128
  });
115
129
  (0, _defineProperty2.default)(this, "setRecursive", function (value) {
116
130
  _this.attributes.recursive = value;
117
131
  });
132
+ // string # The time interval that notifications are aggregated to
118
133
  (0, _defineProperty2.default)(this, "getSendInterval", function () {
119
134
  return _this.attributes.send_interval;
120
135
  });
121
136
  (0, _defineProperty2.default)(this, "setSendInterval", function (value) {
122
137
  _this.attributes.send_interval = value;
123
138
  });
139
+ // string # Custom message to include in notification emails.
124
140
  (0, _defineProperty2.default)(this, "getMessage", function () {
125
141
  return _this.attributes.message;
126
142
  });
127
143
  (0, _defineProperty2.default)(this, "setMessage", function (value) {
128
144
  _this.attributes.message = value;
129
145
  });
146
+ // array # Array of filenames (possibly with wildcards) to match for action path
130
147
  (0, _defineProperty2.default)(this, "getTriggeringFilenames", function () {
131
148
  return _this.attributes.triggering_filenames;
132
149
  });
133
150
  (0, _defineProperty2.default)(this, "setTriggeringFilenames", function (value) {
134
151
  _this.attributes.triggering_filenames = value;
135
152
  });
153
+ // boolean # Is the user unsubscribed from this notification?
136
154
  (0, _defineProperty2.default)(this, "getUnsubscribed", function () {
137
155
  return _this.attributes.unsubscribed;
138
156
  });
139
157
  (0, _defineProperty2.default)(this, "setUnsubscribed", function (value) {
140
158
  _this.attributes.unsubscribed = value;
141
159
  });
160
+ // string # The reason that the user unsubscribed
142
161
  (0, _defineProperty2.default)(this, "getUnsubscribedReason", function () {
143
162
  return _this.attributes.unsubscribed_reason;
144
163
  });
145
164
  (0, _defineProperty2.default)(this, "setUnsubscribedReason", function (value) {
146
165
  _this.attributes.unsubscribed_reason = value;
147
166
  });
167
+ // int64 # Notification user ID
148
168
  (0, _defineProperty2.default)(this, "getUserId", function () {
149
169
  return _this.attributes.user_id;
150
170
  });
151
171
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
152
172
  _this.attributes.user_id = value;
153
173
  });
174
+ // string # Notification username
154
175
  (0, _defineProperty2.default)(this, "getUsername", function () {
155
176
  return _this.attributes.username;
156
177
  });
157
178
  (0, _defineProperty2.default)(this, "setUsername", function (value) {
158
179
  _this.attributes.username = value;
159
180
  });
181
+ // boolean # If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
160
182
  (0, _defineProperty2.default)(this, "getSuppressedEmail", function () {
161
183
  return _this.attributes.suppressed_email;
162
184
  });
163
185
  (0, _defineProperty2.default)(this, "setSuppressedEmail", function (value) {
164
186
  _this.attributes.suppressed_email = value;
165
187
  });
188
+ // Parameters:
189
+ // notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
190
+ // notify_on_delete - boolean - Triggers notification when deleting files from this path
191
+ // notify_on_download - boolean - Triggers notification when downloading files from this path
192
+ // notify_on_move - boolean - Triggers notification when moving files to this path
193
+ // notify_on_upload - boolean - Triggers notification when uploading new files to this path
194
+ // notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
195
+ // recursive - boolean - If `true`, enable notifications for each subfolder in this path
196
+ // send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
197
+ // message - string - Custom message to include in notification emails.
198
+ // triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
199
+ // triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
200
+ // triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
201
+ // trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
166
202
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
167
203
  var params,
168
204
  response,
@@ -323,6 +359,20 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
323
359
  });
324
360
  this.options = _objectSpread({}, options);
325
361
  });
362
+ // Parameters:
363
+ // user_id - int64 - DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
364
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
365
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
366
+ // 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 `path`, `user_id` or `group_id`.
367
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
368
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
369
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
370
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
371
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
372
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
373
+ // group_id - int64 - DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
374
+ // path - string - Show notifications for this Path.
375
+ // include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
326
376
  (0, _defineProperty2.default)(Notification, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
327
377
  var _response$data;
328
378
  var params,
@@ -382,6 +432,8 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
382
432
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
383
433
  return Notification.list(params, options);
384
434
  });
435
+ // Parameters:
436
+ // id (required) - int64 - Notification ID.
385
437
  (0, _defineProperty2.default)(Notification, "find", /*#__PURE__*/function () {
386
438
  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
387
439
  var params,
@@ -432,6 +484,24 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
432
484
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
433
485
  return Notification.find(id, params, options);
434
486
  });
487
+ // Parameters:
488
+ // user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
489
+ // notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
490
+ // notify_on_delete - boolean - Triggers notification when deleting files from this path
491
+ // notify_on_download - boolean - Triggers notification when downloading files from this path
492
+ // notify_on_move - boolean - Triggers notification when moving files to this path
493
+ // notify_on_upload - boolean - Triggers notification when uploading new files to this path
494
+ // notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
495
+ // recursive - boolean - If `true`, enable notifications for each subfolder in this path
496
+ // send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
497
+ // message - string - Custom message to include in notification emails.
498
+ // triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
499
+ // triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
500
+ // triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
501
+ // trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
502
+ // group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
503
+ // path - string - Path
504
+ // username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
435
505
  (0, _defineProperty2.default)(Notification, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
436
506
  var params,
437
507
  options,
@@ -31,45 +31,59 @@ var Payment = /*#__PURE__*/(0, _createClass2.default)(function Payment() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Line item Id
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
38
+ // double # Line item amount
37
39
  (0, _defineProperty2.default)(this, "getAmount", function () {
38
40
  return _this.attributes.amount;
39
41
  });
42
+ // double # Line item balance
40
43
  (0, _defineProperty2.default)(this, "getBalance", function () {
41
44
  return _this.attributes.balance;
42
45
  });
46
+ // date-time # Line item created at
43
47
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
44
48
  return _this.attributes.created_at;
45
49
  });
50
+ // string # Line item currency
46
51
  (0, _defineProperty2.default)(this, "getCurrency", function () {
47
52
  return _this.attributes.currency;
48
53
  });
54
+ // string # Line item download uri
49
55
  (0, _defineProperty2.default)(this, "getDownloadUri", function () {
50
56
  return _this.attributes.download_uri;
51
57
  });
58
+ // array # Associated invoice line items
52
59
  (0, _defineProperty2.default)(this, "getInvoiceLineItems", function () {
53
60
  return _this.attributes.invoice_line_items;
54
61
  });
62
+ // string # Line item payment method
55
63
  (0, _defineProperty2.default)(this, "getMethod", function () {
56
64
  return _this.attributes.method;
57
65
  });
66
+ // array # Associated payment line items
58
67
  (0, _defineProperty2.default)(this, "getPaymentLineItems", function () {
59
68
  return _this.attributes.payment_line_items;
60
69
  });
70
+ // date-time # Date/time payment was reversed if applicable
61
71
  (0, _defineProperty2.default)(this, "getPaymentReversedAt", function () {
62
72
  return _this.attributes.payment_reversed_at;
63
73
  });
74
+ // string # Type of payment if applicable
64
75
  (0, _defineProperty2.default)(this, "getPaymentType", function () {
65
76
  return _this.attributes.payment_type;
66
77
  });
78
+ // string # Site name this line item is for
67
79
  (0, _defineProperty2.default)(this, "getSiteName", function () {
68
80
  return _this.attributes.site_name;
69
81
  });
82
+ // string # Type of line item, either payment or invoice
70
83
  (0, _defineProperty2.default)(this, "getType", function () {
71
84
  return _this.attributes.type;
72
85
  });
86
+ // date-time # Line item updated at
73
87
  (0, _defineProperty2.default)(this, "getUpdatedAt", function () {
74
88
  return _this.attributes.updated_at;
75
89
  });
@@ -86,6 +100,9 @@ var Payment = /*#__PURE__*/(0, _createClass2.default)(function Payment() {
86
100
  });
87
101
  this.options = _objectSpread({}, options);
88
102
  });
103
+ // Parameters:
104
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
105
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
89
106
  (0, _defineProperty2.default)(Payment, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
90
107
  var _response$data;
91
108
  var params,
@@ -127,6 +144,8 @@ var Payment = /*#__PURE__*/(0, _createClass2.default)(function Payment() {
127
144
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
128
145
  return Payment.list(params, options);
129
146
  });
147
+ // Parameters:
148
+ // id (required) - int64 - Payment ID.
130
149
  (0, _defineProperty2.default)(Payment, "find", /*#__PURE__*/function () {
131
150
  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
132
151
  var params,
@@ -29,15 +29,19 @@ var PaymentLineItem = /*#__PURE__*/(0, _createClass2.default)(function PaymentLi
29
29
  (0, _defineProperty2.default)(this, "isLoaded", function () {
30
30
  return !!_this.attributes.id;
31
31
  });
32
+ // double # Payment line item amount
32
33
  (0, _defineProperty2.default)(this, "getAmount", function () {
33
34
  return _this.attributes.amount;
34
35
  });
36
+ // date-time # Payment line item created at date/time
35
37
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
36
38
  return _this.attributes.created_at;
37
39
  });
40
+ // int64 # Invoice ID
38
41
  (0, _defineProperty2.default)(this, "getInvoiceId", function () {
39
42
  return _this.attributes.invoice_id;
40
43
  });
44
+ // int64 # Payment ID
41
45
  (0, _defineProperty2.default)(this, "getPaymentId", function () {
42
46
  return _this.attributes.payment_id;
43
47
  });
@@ -31,48 +31,56 @@ var Permission = /*#__PURE__*/(0, _createClass2.default)(function Permission() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Permission ID
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
37
38
  (0, _defineProperty2.default)(this, "setId", function (value) {
38
39
  _this.attributes.id = value;
39
40
  });
41
+ // string # Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
40
42
  (0, _defineProperty2.default)(this, "getPath", function () {
41
43
  return _this.attributes.path;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setPath", function (value) {
44
46
  _this.attributes.path = value;
45
47
  });
48
+ // int64 # User ID
46
49
  (0, _defineProperty2.default)(this, "getUserId", function () {
47
50
  return _this.attributes.user_id;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
50
53
  _this.attributes.user_id = value;
51
54
  });
55
+ // string # User's username
52
56
  (0, _defineProperty2.default)(this, "getUsername", function () {
53
57
  return _this.attributes.username;
54
58
  });
55
59
  (0, _defineProperty2.default)(this, "setUsername", function (value) {
56
60
  _this.attributes.username = value;
57
61
  });
62
+ // int64 # Group ID
58
63
  (0, _defineProperty2.default)(this, "getGroupId", function () {
59
64
  return _this.attributes.group_id;
60
65
  });
61
66
  (0, _defineProperty2.default)(this, "setGroupId", function (value) {
62
67
  _this.attributes.group_id = value;
63
68
  });
69
+ // string # Group name if applicable
64
70
  (0, _defineProperty2.default)(this, "getGroupName", function () {
65
71
  return _this.attributes.group_name;
66
72
  });
67
73
  (0, _defineProperty2.default)(this, "setGroupName", function (value) {
68
74
  _this.attributes.group_name = value;
69
75
  });
76
+ // string # Permission type
70
77
  (0, _defineProperty2.default)(this, "getPermission", function () {
71
78
  return _this.attributes.permission;
72
79
  });
73
80
  (0, _defineProperty2.default)(this, "setPermission", function (value) {
74
81
  _this.attributes.permission = value;
75
82
  });
83
+ // boolean # Does this permission apply to subfolders?
76
84
  (0, _defineProperty2.default)(this, "getRecursive", function () {
77
85
  return _this.attributes.recursive;
78
86
  });
@@ -157,6 +165,20 @@ var Permission = /*#__PURE__*/(0, _createClass2.default)(function Permission() {
157
165
  });
158
166
  this.options = _objectSpread({}, options);
159
167
  });
168
+ // Parameters:
169
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
170
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
171
+ // 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 `group_id`, `path`, `user_id` or `permission`.
172
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
173
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
174
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
175
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
176
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
177
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
178
+ // path - string - DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
179
+ // group_id - string - DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
180
+ // user_id - string - DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
181
+ // include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
160
182
  (0, _defineProperty2.default)(Permission, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
161
183
  var _response$data;
162
184
  var params,
@@ -216,6 +238,13 @@ var Permission = /*#__PURE__*/(0, _createClass2.default)(function Permission() {
216
238
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
217
239
  return Permission.list(params, options);
218
240
  });
241
+ // Parameters:
242
+ // group_id - int64 - Group ID
243
+ // path - string - Folder path
244
+ // permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
245
+ // recursive - boolean - Apply to subfolders recursively?
246
+ // user_id - int64 - User ID. Provide `username` or `user_id`
247
+ // username - string - User username. Provide `username` or `user_id`
219
248
  (0, _defineProperty2.default)(Permission, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
220
249
  var params,
221
250
  options,
@@ -29,18 +29,23 @@ var Preview = /*#__PURE__*/(0, _createClass2.default)(function Preview() {
29
29
  (0, _defineProperty2.default)(this, "isLoaded", function () {
30
30
  return !!_this.attributes.id;
31
31
  });
32
+ // int64 # Preview ID
32
33
  (0, _defineProperty2.default)(this, "getId", function () {
33
34
  return _this.attributes.id;
34
35
  });
36
+ // string # Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
35
37
  (0, _defineProperty2.default)(this, "getStatus", function () {
36
38
  return _this.attributes.status;
37
39
  });
40
+ // string # Link to download preview
38
41
  (0, _defineProperty2.default)(this, "getDownloadUri", function () {
39
42
  return _this.attributes.download_uri;
40
43
  });
44
+ // string # Preview type. Can be image, pdf, pdf_native, video, or audio
41
45
  (0, _defineProperty2.default)(this, "getType", function () {
42
46
  return _this.attributes.type;
43
47
  });
48
+ // string # Preview size
44
49
  (0, _defineProperty2.default)(this, "getSize", function () {
45
50
  return _this.attributes.size;
46
51
  });
@@ -31,9 +31,11 @@ var Priority = /*#__PURE__*/(0, _createClass2.default)(function Priority() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.path;
33
33
  });
34
+ // string # The path corresponding to the priority color This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
34
35
  (0, _defineProperty2.default)(this, "getPath", function () {
35
36
  return _this.attributes.path;
36
37
  });
38
+ // string # The priority color
37
39
  (0, _defineProperty2.default)(this, "getColor", function () {
38
40
  return _this.attributes.color;
39
41
  });
@@ -50,6 +52,10 @@ var Priority = /*#__PURE__*/(0, _createClass2.default)(function Priority() {
50
52
  });
51
53
  this.options = _objectSpread({}, options);
52
54
  });
55
+ // Parameters:
56
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
57
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
+ // path (required) - string - The path to query for priorities
53
59
  (0, _defineProperty2.default)(Priority, "list", /*#__PURE__*/function () {
54
60
  var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(path) {
55
61
  var _response$data;
@@ -31,18 +31,22 @@ var Project = /*#__PURE__*/(0, _createClass2.default)(function Project() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Project ID
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
37
38
  (0, _defineProperty2.default)(this, "setId", function (value) {
38
39
  _this.attributes.id = value;
39
40
  });
41
+ // string # Global access settings
40
42
  (0, _defineProperty2.default)(this, "getGlobalAccess", function () {
41
43
  return _this.attributes.global_access;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setGlobalAccess", function (value) {
44
46
  _this.attributes.global_access = value;
45
47
  });
48
+ // Parameters:
49
+ // global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
46
50
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
47
51
  var params,
48
52
  response,
@@ -193,6 +197,9 @@ var Project = /*#__PURE__*/(0, _createClass2.default)(function Project() {
193
197
  });
194
198
  this.options = _objectSpread({}, options);
195
199
  });
200
+ // Parameters:
201
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
202
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
196
203
  (0, _defineProperty2.default)(Project, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
197
204
  var _response$data;
198
205
  var params,
@@ -234,6 +241,8 @@ var Project = /*#__PURE__*/(0, _createClass2.default)(function Project() {
234
241
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
235
242
  return Project.list(params, options);
236
243
  });
244
+ // Parameters:
245
+ // id (required) - int64 - Project ID.
237
246
  (0, _defineProperty2.default)(Project, "find", /*#__PURE__*/function () {
238
247
  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
239
248
  var params,
@@ -284,6 +293,8 @@ var Project = /*#__PURE__*/(0, _createClass2.default)(function Project() {
284
293
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
285
294
  return Project.find(id, params, options);
286
295
  });
296
+ // Parameters:
297
+ // global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
287
298
  (0, _defineProperty2.default)(Project, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
288
299
  var params,
289
300
  options,
@@ -29,15 +29,19 @@ var PublicIpAddress = /*#__PURE__*/(0, _createClass2.default)(function PublicIpA
29
29
  (0, _defineProperty2.default)(this, "isLoaded", function () {
30
30
  return !!_this.attributes.id;
31
31
  });
32
+ // string # The public IP address.
32
33
  (0, _defineProperty2.default)(this, "getIpAddress", function () {
33
34
  return _this.attributes.ip_address;
34
35
  });
36
+ // string # The name of the frontend server.
35
37
  (0, _defineProperty2.default)(this, "getServerName", function () {
36
38
  return _this.attributes.server_name;
37
39
  });
40
+ // boolean
38
41
  (0, _defineProperty2.default)(this, "getFtpEnabled", function () {
39
42
  return _this.attributes.ftp_enabled;
40
43
  });
44
+ // boolean
41
45
  (0, _defineProperty2.default)(this, "getSftpEnabled", function () {
42
46
  return _this.attributes.sftp_enabled;
43
47
  });
@@ -31,39 +31,47 @@ var PublicKey = /*#__PURE__*/(0, _createClass2.default)(function PublicKey() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Public key ID
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
37
38
  (0, _defineProperty2.default)(this, "setId", function (value) {
38
39
  _this.attributes.id = value;
39
40
  });
41
+ // string # Public key title
40
42
  (0, _defineProperty2.default)(this, "getTitle", function () {
41
43
  return _this.attributes.title;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setTitle", function (value) {
44
46
  _this.attributes.title = value;
45
47
  });
48
+ // date-time # Public key created at date/time
46
49
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
47
50
  return _this.attributes.created_at;
48
51
  });
52
+ // string # Public key fingerprint
49
53
  (0, _defineProperty2.default)(this, "getFingerprint", function () {
50
54
  return _this.attributes.fingerprint;
51
55
  });
52
56
  (0, _defineProperty2.default)(this, "setFingerprint", function (value) {
53
57
  _this.attributes.fingerprint = value;
54
58
  });
59
+ // int64 # User ID. Provide a value of `0` to operate the current session's user.
55
60
  (0, _defineProperty2.default)(this, "getUserId", function () {
56
61
  return _this.attributes.user_id;
57
62
  });
58
63
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
59
64
  _this.attributes.user_id = value;
60
65
  });
66
+ // string # Actual contents of SSH key.
61
67
  (0, _defineProperty2.default)(this, "getPublicKey", function () {
62
68
  return _this.attributes.public_key;
63
69
  });
64
70
  (0, _defineProperty2.default)(this, "setPublicKey", function (value) {
65
71
  _this.attributes.public_key = value;
66
72
  });
73
+ // Parameters:
74
+ // title (required) - string - Internal reference for key.
67
75
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
68
76
  var params,
69
77
  response,
@@ -214,6 +222,10 @@ var PublicKey = /*#__PURE__*/(0, _createClass2.default)(function PublicKey() {
214
222
  });
215
223
  this.options = _objectSpread({}, options);
216
224
  });
225
+ // Parameters:
226
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
227
+ // 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
228
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
217
229
  (0, _defineProperty2.default)(PublicKey, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
218
230
  var _response$data;
219
231
  var params,
@@ -261,6 +273,8 @@ var PublicKey = /*#__PURE__*/(0, _createClass2.default)(function PublicKey() {
261
273
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
262
274
  return PublicKey.list(params, options);
263
275
  });
276
+ // Parameters:
277
+ // id (required) - int64 - Public Key ID.
264
278
  (0, _defineProperty2.default)(PublicKey, "find", /*#__PURE__*/function () {
265
279
  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
266
280
  var params,
@@ -311,6 +325,10 @@ var PublicKey = /*#__PURE__*/(0, _createClass2.default)(function PublicKey() {
311
325
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
312
326
  return PublicKey.find(id, params, options);
313
327
  });
328
+ // Parameters:
329
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
330
+ // title (required) - string - Internal reference for key.
331
+ // public_key (required) - string - Actual contents of SSH key.
314
332
  (0, _defineProperty2.default)(PublicKey, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
315
333
  var params,
316
334
  options,