files.com 1.0.248 → 1.0.249

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 (79) hide show
  1. package/_VERSION +1 -1
  2. package/lib/models/AccountLineItem.js +14 -0
  3. package/lib/models/Action.js +13 -0
  4. package/lib/models/ActionNotificationExport.js +27 -0
  5. package/lib/models/ActionNotificationExportResult.js +15 -0
  6. package/lib/models/ActionWebhookFailure.js +1 -0
  7. package/lib/models/ApiKey.js +42 -0
  8. package/lib/models/App.js +26 -0
  9. package/lib/models/As2IncomingMessage.js +46 -0
  10. package/lib/models/As2OutgoingMessage.js +42 -0
  11. package/lib/models/As2Partner.js +29 -0
  12. package/lib/models/As2Station.js +31 -0
  13. package/lib/models/Auto.js +1 -0
  14. package/lib/models/Automation.js +72 -0
  15. package/lib/models/AutomationRun.js +20 -0
  16. package/lib/models/BandwidthSnapshot.js +19 -0
  17. package/lib/models/Behavior.js +57 -0
  18. package/lib/models/Bundle.js +98 -0
  19. package/lib/models/BundleDownload.js +16 -0
  20. package/lib/models/BundleNotification.js +20 -0
  21. package/lib/models/BundleRecipient.js +28 -0
  22. package/lib/models/BundleRegistration.js +18 -0
  23. package/lib/models/Clickwrap.js +23 -0
  24. package/lib/models/DnsRecord.js +7 -0
  25. package/lib/models/Errors.js +2 -0
  26. package/lib/models/ExternalEvent.js +26 -0
  27. package/lib/models/File.js +88 -0
  28. package/lib/models/FileAction.js +2 -0
  29. package/lib/models/FileComment.js +13 -0
  30. package/lib/models/FileCommentReaction.js +8 -0
  31. package/lib/models/FileMigration.js +11 -0
  32. package/lib/models/FileUploadPart.js +15 -0
  33. package/lib/models/Folder.js +33 -0
  34. package/lib/models/FormField.js +8 -0
  35. package/lib/models/FormFieldSet.js +27 -0
  36. package/lib/models/Group.js +29 -0
  37. package/lib/models/GroupUser.js +22 -0
  38. package/lib/models/History.js +57 -0
  39. package/lib/models/HistoryExport.js +51 -0
  40. package/lib/models/HistoryExportResult.js +29 -0
  41. package/lib/models/Image.js +2 -0
  42. package/lib/models/InboxRecipient.js +28 -0
  43. package/lib/models/InboxRegistration.js +15 -0
  44. package/lib/models/InboxUpload.js +15 -0
  45. package/lib/models/Invoice.js +19 -0
  46. package/lib/models/InvoiceLineItem.js +9 -0
  47. package/lib/models/IpAddress.js +13 -0
  48. package/lib/models/Lock.js +25 -0
  49. package/lib/models/Message.js +22 -0
  50. package/lib/models/MessageComment.js +16 -0
  51. package/lib/models/MessageCommentReaction.js +13 -0
  52. package/lib/models/MessageReaction.js +13 -0
  53. package/lib/models/Notification.js +70 -0
  54. package/lib/models/Payment.js +19 -0
  55. package/lib/models/PaymentLineItem.js +4 -0
  56. package/lib/models/Permission.js +29 -0
  57. package/lib/models/Preview.js +5 -0
  58. package/lib/models/Priority.js +6 -0
  59. package/lib/models/Project.js +11 -0
  60. package/lib/models/PublicIpAddress.js +4 -0
  61. package/lib/models/PublicKey.js +18 -0
  62. package/lib/models/RemoteBandwidthSnapshot.js +15 -0
  63. package/lib/models/RemoteServer.js +194 -0
  64. package/lib/models/RemoteServerConfigurationFile.js +12 -0
  65. package/lib/models/Request.js +25 -0
  66. package/lib/models/Session.js +13 -0
  67. package/lib/models/SettingsChange.js +15 -0
  68. package/lib/models/SftpHostKey.js +16 -0
  69. package/lib/models/Site.js +276 -0
  70. package/lib/models/SsoStrategy.js +49 -0
  71. package/lib/models/Status.js +7 -0
  72. package/lib/models/Style.js +9 -0
  73. package/lib/models/UsageDailySnapshot.js +21 -0
  74. package/lib/models/UsageSnapshot.js +18 -0
  75. package/lib/models/User.js +183 -0
  76. package/lib/models/UserCipherUse.js +10 -0
  77. package/lib/models/UserRequest.js +13 -0
  78. package/lib/models/WebhookTest.js +24 -0
  79. package/package.json +1 -1
@@ -31,138 +31,178 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Automation 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 # Automation type
40
42
  (0, _defineProperty2.default)(this, "getAutomation", function () {
41
43
  return _this.attributes.automation;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setAutomation", function (value) {
44
46
  _this.attributes.automation = value;
45
47
  });
48
+ // boolean # Indicates if the automation has been deleted.
46
49
  (0, _defineProperty2.default)(this, "getDeleted", function () {
47
50
  return _this.attributes.deleted;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setDeleted", function (value) {
50
53
  _this.attributes.deleted = value;
51
54
  });
55
+ // boolean # If true, this automation will not run.
52
56
  (0, _defineProperty2.default)(this, "getDisabled", function () {
53
57
  return _this.attributes.disabled;
54
58
  });
55
59
  (0, _defineProperty2.default)(this, "setDisabled", function (value) {
56
60
  _this.attributes.disabled = value;
57
61
  });
62
+ // string # How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
58
63
  (0, _defineProperty2.default)(this, "getTrigger", function () {
59
64
  return _this.attributes.trigger;
60
65
  });
61
66
  (0, _defineProperty2.default)(this, "setTrigger", function (value) {
62
67
  _this.attributes.trigger = value;
63
68
  });
69
+ // 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`
64
70
  (0, _defineProperty2.default)(this, "getInterval", function () {
65
71
  return _this.attributes.interval;
66
72
  });
67
73
  (0, _defineProperty2.default)(this, "setInterval", function (value) {
68
74
  _this.attributes.interval = value;
69
75
  });
76
+ // date-time # Time when automation was last modified. Does not change for name or description updates.
70
77
  (0, _defineProperty2.default)(this, "getLastModifiedAt", function () {
71
78
  return _this.attributes.last_modified_at;
72
79
  });
73
80
  (0, _defineProperty2.default)(this, "setLastModifiedAt", function (value) {
74
81
  _this.attributes.last_modified_at = value;
75
82
  });
83
+ // string # Name for this automation.
76
84
  (0, _defineProperty2.default)(this, "getName", function () {
77
85
  return _this.attributes.name;
78
86
  });
79
87
  (0, _defineProperty2.default)(this, "setName", function (value) {
80
88
  _this.attributes.name = value;
81
89
  });
90
+ // object # If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
82
91
  (0, _defineProperty2.default)(this, "getSchedule", function () {
83
92
  return _this.attributes.schedule;
84
93
  });
85
94
  (0, _defineProperty2.default)(this, "setSchedule", function (value) {
86
95
  _this.attributes.schedule = value;
87
96
  });
97
+ // string # Source Path
88
98
  (0, _defineProperty2.default)(this, "getSource", function () {
89
99
  return _this.attributes.source;
90
100
  });
91
101
  (0, _defineProperty2.default)(this, "setSource", function (value) {
92
102
  _this.attributes.source = value;
93
103
  });
104
+ // array # Destination Path
94
105
  (0, _defineProperty2.default)(this, "getDestinations", function () {
95
106
  return _this.attributes.destinations;
96
107
  });
97
108
  (0, _defineProperty2.default)(this, "setDestinations", function (value) {
98
109
  _this.attributes.destinations = value;
99
110
  });
111
+ // string # If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
100
112
  (0, _defineProperty2.default)(this, "getDestinationReplaceFrom", function () {
101
113
  return _this.attributes.destination_replace_from;
102
114
  });
103
115
  (0, _defineProperty2.default)(this, "setDestinationReplaceFrom", function (value) {
104
116
  _this.attributes.destination_replace_from = value;
105
117
  });
118
+ // string # If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
106
119
  (0, _defineProperty2.default)(this, "getDestinationReplaceTo", function () {
107
120
  return _this.attributes.destination_replace_to;
108
121
  });
109
122
  (0, _defineProperty2.default)(this, "setDestinationReplaceTo", function (value) {
110
123
  _this.attributes.destination_replace_to = value;
111
124
  });
125
+ // string # Description for the this Automation.
112
126
  (0, _defineProperty2.default)(this, "getDescription", function () {
113
127
  return _this.attributes.description;
114
128
  });
115
129
  (0, _defineProperty2.default)(this, "setDescription", function (value) {
116
130
  _this.attributes.description = value;
117
131
  });
132
+ // string # Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
118
133
  (0, _defineProperty2.default)(this, "getPath", function () {
119
134
  return _this.attributes.path;
120
135
  });
121
136
  (0, _defineProperty2.default)(this, "setPath", function (value) {
122
137
  _this.attributes.path = value;
123
138
  });
139
+ // int64 # User ID of the Automation's creator.
124
140
  (0, _defineProperty2.default)(this, "getUserId", function () {
125
141
  return _this.attributes.user_id;
126
142
  });
127
143
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
128
144
  _this.attributes.user_id = value;
129
145
  });
146
+ // array # IDs of Users for the Automation (i.e. who to Request File from)
130
147
  (0, _defineProperty2.default)(this, "getUserIds", function () {
131
148
  return _this.attributes.user_ids;
132
149
  });
133
150
  (0, _defineProperty2.default)(this, "setUserIds", function (value) {
134
151
  _this.attributes.user_ids = value;
135
152
  });
153
+ // array # IDs of Groups for the Automation (i.e. who to Request File from)
136
154
  (0, _defineProperty2.default)(this, "getGroupIds", function () {
137
155
  return _this.attributes.group_ids;
138
156
  });
139
157
  (0, _defineProperty2.default)(this, "setGroupIds", function (value) {
140
158
  _this.attributes.group_ids = value;
141
159
  });
160
+ // string # If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
142
161
  (0, _defineProperty2.default)(this, "getWebhookUrl", function () {
143
162
  return _this.attributes.webhook_url;
144
163
  });
145
164
  (0, _defineProperty2.default)(this, "setWebhookUrl", function (value) {
146
165
  _this.attributes.webhook_url = value;
147
166
  });
167
+ // 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
148
168
  (0, _defineProperty2.default)(this, "getTriggerActions", function () {
149
169
  return _this.attributes.trigger_actions;
150
170
  });
151
171
  (0, _defineProperty2.default)(this, "setTriggerActions", function (value) {
152
172
  _this.attributes.trigger_actions = value;
153
173
  });
174
+ // object # A Hash of attributes specific to the automation type.
154
175
  (0, _defineProperty2.default)(this, "getValue", function () {
155
176
  return _this.attributes.value;
156
177
  });
157
178
  (0, _defineProperty2.default)(this, "setValue", function (value) {
158
179
  _this.attributes.value = value;
159
180
  });
181
+ // string # DEPRECATED: Destination Path. Use `destinations` instead.
160
182
  (0, _defineProperty2.default)(this, "getDestination", function () {
161
183
  return _this.attributes.destination;
162
184
  });
163
185
  (0, _defineProperty2.default)(this, "setDestination", function (value) {
164
186
  _this.attributes.destination = value;
165
187
  });
188
+ // Parameters:
189
+ // source - string - Source Path
190
+ // destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
191
+ // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
192
+ // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
193
+ // 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.
194
+ // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
195
+ // path - string - Path on which this Automation runs. Supports globs.
196
+ // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
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
+ // description - string - Description for the this Automation.
200
+ // disabled - boolean - If true, this automation will not run.
201
+ // name - string - Name for this automation.
202
+ // trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
203
+ // 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
204
+ // value - object - A Hash of attributes specific to the automation type.
205
+ // automation - string - Automation type
166
206
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
167
207
  var params,
168
208
  response,
@@ -377,6 +417,18 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
377
417
  });
378
418
  this.options = _objectSpread({}, options);
379
419
  });
420
+ // Parameters:
421
+ // 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.
422
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
423
+ // 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 `automation`, `disabled` or `last_modified_at`.
424
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
425
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
426
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
427
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
428
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
429
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
430
+ // with_deleted - boolean - Set to true to include deleted automations in the results.
431
+ // automation - string - DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
380
432
  (0, _defineProperty2.default)(Automation, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
381
433
  var _response$data;
382
434
  var params,
@@ -424,6 +476,8 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
424
476
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
425
477
  return Automation.list(params, options);
426
478
  });
479
+ // Parameters:
480
+ // id (required) - int64 - Automation ID.
427
481
  (0, _defineProperty2.default)(Automation, "find", /*#__PURE__*/function () {
428
482
  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
429
483
  var params,
@@ -474,6 +528,24 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
474
528
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
475
529
  return Automation.find(id, params, options);
476
530
  });
531
+ // Parameters:
532
+ // source - string - Source Path
533
+ // destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
534
+ // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
535
+ // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
536
+ // 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.
537
+ // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
538
+ // path - string - Path on which this Automation runs. Supports globs.
539
+ // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
540
+ // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
541
+ // schedule - object - Custom schedule for running this automation.
542
+ // description - string - Description for the this Automation.
543
+ // disabled - boolean - If true, this automation will not run.
544
+ // name - string - Name for this automation.
545
+ // trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
546
+ // 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
547
+ // value - object - A Hash of attributes specific to the automation type.
548
+ // automation (required) - string - Automation type
477
549
  (0, _defineProperty2.default)(Automation, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
478
550
  var params,
479
551
  options,
@@ -31,21 +31,27 @@ var AutomationRun = /*#__PURE__*/(0, _createClass2.default)(function AutomationR
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # ID.
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
38
+ // int64 # ID of the associated Automation.
37
39
  (0, _defineProperty2.default)(this, "getAutomationId", function () {
38
40
  return _this.attributes.automation_id;
39
41
  });
42
+ // date-time # Automation run completion/failure date/time.
40
43
  (0, _defineProperty2.default)(this, "getCompletedAt", function () {
41
44
  return _this.attributes.completed_at;
42
45
  });
46
+ // date-time # Automation run start date/time.
43
47
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
44
48
  return _this.attributes.created_at;
45
49
  });
50
+ // string # The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
46
51
  (0, _defineProperty2.default)(this, "getStatus", function () {
47
52
  return _this.attributes.status;
48
53
  });
54
+ // string # Link to status messages log file.
49
55
  (0, _defineProperty2.default)(this, "getStatusMessagesUrl", function () {
50
56
  return _this.attributes.status_messages_url;
51
57
  });
@@ -62,6 +68,18 @@ var AutomationRun = /*#__PURE__*/(0, _createClass2.default)(function AutomationR
62
68
  });
63
69
  this.options = _objectSpread({}, options);
64
70
  });
71
+ // Parameters:
72
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
73
+ // 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.
74
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
75
+ // 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 `created_at` and `status`.
76
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
77
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
78
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
79
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
80
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
81
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
82
+ // automation_id (required) - int64 - ID of the associated Automation.
65
83
  (0, _defineProperty2.default)(AutomationRun, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
66
84
  var _response$data;
67
85
  var params,
@@ -121,6 +139,8 @@ var AutomationRun = /*#__PURE__*/(0, _createClass2.default)(function AutomationR
121
139
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
122
140
  return AutomationRun.list(params, options);
123
141
  });
142
+ // Parameters:
143
+ // id (required) - int64 - Automation Run ID.
124
144
  (0, _defineProperty2.default)(AutomationRun, "find", /*#__PURE__*/function () {
125
145
  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
126
146
  var params,
@@ -31,30 +31,39 @@ var BandwidthSnapshot = /*#__PURE__*/(0, _createClass2.default)(function Bandwid
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Site bandwidth ID
34
35
  (0, _defineProperty2.default)(this, "getId", function () {
35
36
  return _this.attributes.id;
36
37
  });
38
+ // double # Site bandwidth report bytes received
37
39
  (0, _defineProperty2.default)(this, "getBytesReceived", function () {
38
40
  return _this.attributes.bytes_received;
39
41
  });
42
+ // double # Site bandwidth report bytes sent
40
43
  (0, _defineProperty2.default)(this, "getBytesSent", function () {
41
44
  return _this.attributes.bytes_sent;
42
45
  });
46
+ // double # Site sync bandwidth report bytes received
43
47
  (0, _defineProperty2.default)(this, "getSyncBytesReceived", function () {
44
48
  return _this.attributes.sync_bytes_received;
45
49
  });
50
+ // double # Site sync bandwidth report bytes sent
46
51
  (0, _defineProperty2.default)(this, "getSyncBytesSent", function () {
47
52
  return _this.attributes.sync_bytes_sent;
48
53
  });
54
+ // double # Site bandwidth report get requests
49
55
  (0, _defineProperty2.default)(this, "getRequestsGet", function () {
50
56
  return _this.attributes.requests_get;
51
57
  });
58
+ // double # Site bandwidth report put requests
52
59
  (0, _defineProperty2.default)(this, "getRequestsPut", function () {
53
60
  return _this.attributes.requests_put;
54
61
  });
62
+ // double # Site bandwidth report other requests
55
63
  (0, _defineProperty2.default)(this, "getRequestsOther", function () {
56
64
  return _this.attributes.requests_other;
57
65
  });
66
+ // date-time # Time the site bandwidth report was logged
58
67
  (0, _defineProperty2.default)(this, "getLoggedAt", function () {
59
68
  return _this.attributes.logged_at;
60
69
  });
@@ -71,6 +80,16 @@ var BandwidthSnapshot = /*#__PURE__*/(0, _createClass2.default)(function Bandwid
71
80
  });
72
81
  this.options = _objectSpread({}, options);
73
82
  });
83
+ // Parameters:
84
+ // 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.
85
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
86
+ // 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 `logged_at`.
87
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
88
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
89
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
90
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
91
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
92
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
74
93
  (0, _defineProperty2.default)(BandwidthSnapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
75
94
  var _response$data;
76
95
  var params,
@@ -31,60 +31,77 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # Folder behavior 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
+ // string # URL for attached file
46
49
  (0, _defineProperty2.default)(this, "getAttachmentUrl", function () {
47
50
  return _this.attributes.attachment_url;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setAttachmentUrl", function (value) {
50
53
  _this.attributes.attachment_url = value;
51
54
  });
55
+ // string # Behavior type.
52
56
  (0, _defineProperty2.default)(this, "getBehavior", function () {
53
57
  return _this.attributes.behavior;
54
58
  });
55
59
  (0, _defineProperty2.default)(this, "setBehavior", function (value) {
56
60
  _this.attributes.behavior = value;
57
61
  });
62
+ // string # Name for this behavior.
58
63
  (0, _defineProperty2.default)(this, "getName", function () {
59
64
  return _this.attributes.name;
60
65
  });
61
66
  (0, _defineProperty2.default)(this, "setName", function (value) {
62
67
  _this.attributes.name = value;
63
68
  });
69
+ // string # Description for this behavior.
64
70
  (0, _defineProperty2.default)(this, "getDescription", function () {
65
71
  return _this.attributes.description;
66
72
  });
67
73
  (0, _defineProperty2.default)(this, "setDescription", function (value) {
68
74
  _this.attributes.description = value;
69
75
  });
76
+ // object # Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
70
77
  (0, _defineProperty2.default)(this, "getValue", function () {
71
78
  return _this.attributes.value;
72
79
  });
73
80
  (0, _defineProperty2.default)(this, "setValue", function (value) {
74
81
  _this.attributes.value = value;
75
82
  });
83
+ // file # Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
76
84
  (0, _defineProperty2.default)(this, "getAttachmentFile", function () {
77
85
  return _this.attributes.attachment_file;
78
86
  });
79
87
  (0, _defineProperty2.default)(this, "setAttachmentFile", function (value) {
80
88
  _this.attributes.attachment_file = value;
81
89
  });
90
+ // boolean # If true, will delete the file stored in attachment
82
91
  (0, _defineProperty2.default)(this, "getAttachmentDelete", function () {
83
92
  return _this.attributes.attachment_delete;
84
93
  });
85
94
  (0, _defineProperty2.default)(this, "setAttachmentDelete", function (value) {
86
95
  _this.attributes.attachment_delete = value;
87
96
  });
97
+ // Parameters:
98
+ // value - string - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
99
+ // attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
100
+ // name - string - Name for this behavior.
101
+ // description - string - Description for this behavior.
102
+ // behavior - string - Behavior type.
103
+ // path - string - Folder behaviors path.
104
+ // attachment_delete - boolean - If true, will delete the file stored in attachment
88
105
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
89
106
  var params,
90
107
  response,
@@ -245,6 +262,17 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
245
262
  });
246
263
  this.options = _objectSpread({}, options);
247
264
  });
265
+ // Parameters:
266
+ // 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.
267
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
268
+ // 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 `behavior`.
269
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
270
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
271
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
272
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
273
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
274
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
275
+ // behavior - string - If set, only shows folder behaviors matching this behavior type.
248
276
  (0, _defineProperty2.default)(Behavior, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
249
277
  var _response$data;
250
278
  var params,
@@ -292,6 +320,8 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
292
320
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
293
321
  return Behavior.list(params, options);
294
322
  });
323
+ // Parameters:
324
+ // id (required) - int64 - Behavior ID.
295
325
  (0, _defineProperty2.default)(Behavior, "find", /*#__PURE__*/function () {
296
326
  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
297
327
  var params,
@@ -342,6 +372,19 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
342
372
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
343
373
  return Behavior.find(id, params, options);
344
374
  });
375
+ // Parameters:
376
+ // 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.
377
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
378
+ // 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 `behavior`.
379
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
380
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
381
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
382
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
383
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
384
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
385
+ // path (required) - string - Path to operate on.
386
+ // recursive - string - Show behaviors above this path?
387
+ // behavior - string - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
345
388
  (0, _defineProperty2.default)(Behavior, "listFor", /*#__PURE__*/function () {
346
389
  var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(path) {
347
390
  var _response$data2;
@@ -414,6 +457,13 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
414
457
  return _ref7.apply(this, arguments);
415
458
  };
416
459
  }());
460
+ // Parameters:
461
+ // value - string - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
462
+ // attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
463
+ // name - string - Name for this behavior.
464
+ // description - string - Description for this behavior.
465
+ // path (required) - string - Folder behaviors path.
466
+ // behavior (required) - string - Behavior type.
417
467
  (0, _defineProperty2.default)(Behavior, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
418
468
  var params,
419
469
  options,
@@ -477,6 +527,13 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
477
527
  }
478
528
  }, _callee6);
479
529
  })));
530
+ // Parameters:
531
+ // url (required) - string - URL for testing the webhook.
532
+ // method - string - HTTP method(GET or POST).
533
+ // encoding - string - HTTP encoding method. Can be JSON, XML, or RAW (form data).
534
+ // headers - object - Additional request headers.
535
+ // body - object - Additional body parameters.
536
+ // action - string - action for test body
480
537
  (0, _defineProperty2.default)(Behavior, "webhookTest", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
481
538
  var params,
482
539
  options,