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
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.248
1
+ 1.0.250
@@ -26,6 +26,7 @@
26
26
  "bundle_watermark_value": {
27
27
  "key": "example value"
28
28
  },
29
+ "uploads_via_email_authentication": true,
29
30
  "color2_left": "#0066a7",
30
31
  "color2_link": "#d34f5d",
31
32
  "color2_text": "#0066a7",
@@ -171,6 +172,7 @@
171
172
  * `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
172
173
  * `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
173
174
  * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
175
+ * `uploads_via_email_authentication` (boolean): Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
174
176
  * `color2_left` (string): Page link and button color
175
177
  * `color2_link` (string): Top bar link color
176
178
  * `color2_text` (string): Page link and button color
@@ -434,6 +436,7 @@ await Site.update({
434
436
  'ldap_group_exclusion': "example",
435
437
  'ldap_group_inclusion': "example",
436
438
  'ldap_base_dn': "example",
439
+ 'uploads_via_email_authentication': true,
437
440
  'icon16_delete': true,
438
441
  'icon32_delete': true,
439
442
  'icon48_delete': true,
@@ -564,6 +567,7 @@ await Site.update({
564
567
  * `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
565
568
  * `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
566
569
  * `ldap_base_dn` (string): Base DN for looking up users in LDAP server
570
+ * `uploads_via_email_authentication` (boolean): Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
567
571
  * `icon16_file` (file):
568
572
  * `icon16_delete` (boolean): If true, will delete the file stored in icon16
569
573
  * `icon32_file` (file):
@@ -29,45 +29,59 @@ var AccountLineItem = /*#__PURE__*/(0, _createClass2.default)(function AccountLi
29
29
  (0, _defineProperty2.default)(this, "isLoaded", function () {
30
30
  return !!_this.attributes.id;
31
31
  });
32
+ // int64 # Line item Id
32
33
  (0, _defineProperty2.default)(this, "getId", function () {
33
34
  return _this.attributes.id;
34
35
  });
36
+ // double # Line item amount
35
37
  (0, _defineProperty2.default)(this, "getAmount", function () {
36
38
  return _this.attributes.amount;
37
39
  });
40
+ // double # Line item balance
38
41
  (0, _defineProperty2.default)(this, "getBalance", function () {
39
42
  return _this.attributes.balance;
40
43
  });
44
+ // date-time # Line item created at
41
45
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
42
46
  return _this.attributes.created_at;
43
47
  });
48
+ // string # Line item currency
44
49
  (0, _defineProperty2.default)(this, "getCurrency", function () {
45
50
  return _this.attributes.currency;
46
51
  });
52
+ // string # Line item download uri
47
53
  (0, _defineProperty2.default)(this, "getDownloadUri", function () {
48
54
  return _this.attributes.download_uri;
49
55
  });
56
+ // array # Associated invoice line items
50
57
  (0, _defineProperty2.default)(this, "getInvoiceLineItems", function () {
51
58
  return _this.attributes.invoice_line_items;
52
59
  });
60
+ // string # Line item payment method
53
61
  (0, _defineProperty2.default)(this, "getMethod", function () {
54
62
  return _this.attributes.method;
55
63
  });
64
+ // array # Associated payment line items
56
65
  (0, _defineProperty2.default)(this, "getPaymentLineItems", function () {
57
66
  return _this.attributes.payment_line_items;
58
67
  });
68
+ // date-time # Date/time payment was reversed if applicable
59
69
  (0, _defineProperty2.default)(this, "getPaymentReversedAt", function () {
60
70
  return _this.attributes.payment_reversed_at;
61
71
  });
72
+ // string # Type of payment if applicable
62
73
  (0, _defineProperty2.default)(this, "getPaymentType", function () {
63
74
  return _this.attributes.payment_type;
64
75
  });
76
+ // string # Site name this line item is for
65
77
  (0, _defineProperty2.default)(this, "getSiteName", function () {
66
78
  return _this.attributes.site_name;
67
79
  });
80
+ // string # Type of line item, either payment or invoice
68
81
  (0, _defineProperty2.default)(this, "getType", function () {
69
82
  return _this.attributes.type;
70
83
  });
84
+ // date-time # Line item updated at
71
85
  (0, _defineProperty2.default)(this, "getUpdatedAt", function () {
72
86
  return _this.attributes.updated_at;
73
87
  });
@@ -29,42 +29,55 @@ var Action = /*#__PURE__*/(0, _createClass2.default)(function Action() {
29
29
  (0, _defineProperty2.default)(this, "isLoaded", function () {
30
30
  return !!_this.attributes.id;
31
31
  });
32
+ // int64 # Action ID
32
33
  (0, _defineProperty2.default)(this, "getId", function () {
33
34
  return _this.attributes.id;
34
35
  });
36
+ // string # Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
35
37
  (0, _defineProperty2.default)(this, "getPath", function () {
36
38
  return _this.attributes.path;
37
39
  });
40
+ // date-time # Action occurrence date/time
38
41
  (0, _defineProperty2.default)(this, "getWhen", function () {
39
42
  return _this.attributes.when;
40
43
  });
44
+ // string # The destination path for this action, if applicable
41
45
  (0, _defineProperty2.default)(this, "getDestination", function () {
42
46
  return _this.attributes.destination;
43
47
  });
48
+ // string # Friendly displayed output
44
49
  (0, _defineProperty2.default)(this, "getDisplay", function () {
45
50
  return _this.attributes.display;
46
51
  });
52
+ // string # IP Address that performed this action
47
53
  (0, _defineProperty2.default)(this, "getIp", function () {
48
54
  return _this.attributes.ip;
49
55
  });
56
+ // string # The source path for this action, if applicable
50
57
  (0, _defineProperty2.default)(this, "getSource", function () {
51
58
  return _this.attributes.source;
52
59
  });
60
+ // array # Targets
53
61
  (0, _defineProperty2.default)(this, "getTargets", function () {
54
62
  return _this.attributes.targets;
55
63
  });
64
+ // int64 # User ID
56
65
  (0, _defineProperty2.default)(this, "getUserId", function () {
57
66
  return _this.attributes.user_id;
58
67
  });
68
+ // string # Username
59
69
  (0, _defineProperty2.default)(this, "getUsername", function () {
60
70
  return _this.attributes.username;
61
71
  });
72
+ // string # Type of action
62
73
  (0, _defineProperty2.default)(this, "getAction", function () {
63
74
  return _this.attributes.action;
64
75
  });
76
+ // string # Failure type. If action was a user login or session failure, why did it fail?
65
77
  (0, _defineProperty2.default)(this, "getFailureType", function () {
66
78
  return _this.attributes.failure_type;
67
79
  });
80
+ // string # Interface on which this action occurred.
68
81
  (0, _defineProperty2.default)(this, "getInterface", function () {
69
82
  return _this.attributes.interface;
70
83
  });
@@ -31,84 +31,98 @@ var ActionNotificationExport = /*#__PURE__*/(0, _createClass2.default)(function
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # History Export 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 # Version of the underlying records for the export.
40
42
  (0, _defineProperty2.default)(this, "getExportVersion", function () {
41
43
  return _this.attributes.export_version;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setExportVersion", function (value) {
44
46
  _this.attributes.export_version = value;
45
47
  });
48
+ // date-time # Start date/time of export range.
46
49
  (0, _defineProperty2.default)(this, "getStartAt", function () {
47
50
  return _this.attributes.start_at;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setStartAt", function (value) {
50
53
  _this.attributes.start_at = value;
51
54
  });
55
+ // date-time # End date/time of export range.
52
56
  (0, _defineProperty2.default)(this, "getEndAt", function () {
53
57
  return _this.attributes.end_at;
54
58
  });
55
59
  (0, _defineProperty2.default)(this, "setEndAt", function (value) {
56
60
  _this.attributes.end_at = value;
57
61
  });
62
+ // string # Status of export. Valid values: `building`, `ready`, or `failed`
58
63
  (0, _defineProperty2.default)(this, "getStatus", function () {
59
64
  return _this.attributes.status;
60
65
  });
61
66
  (0, _defineProperty2.default)(this, "setStatus", function (value) {
62
67
  _this.attributes.status = value;
63
68
  });
69
+ // string # Return notifications that were triggered by actions on this specific path.
64
70
  (0, _defineProperty2.default)(this, "getQueryPath", function () {
65
71
  return _this.attributes.query_path;
66
72
  });
67
73
  (0, _defineProperty2.default)(this, "setQueryPath", function (value) {
68
74
  _this.attributes.query_path = value;
69
75
  });
76
+ // string # Return notifications that were triggered by actions in this folder.
70
77
  (0, _defineProperty2.default)(this, "getQueryFolder", function () {
71
78
  return _this.attributes.query_folder;
72
79
  });
73
80
  (0, _defineProperty2.default)(this, "setQueryFolder", function (value) {
74
81
  _this.attributes.query_folder = value;
75
82
  });
83
+ // string # Error message associated with the request, if any.
76
84
  (0, _defineProperty2.default)(this, "getQueryMessage", function () {
77
85
  return _this.attributes.query_message;
78
86
  });
79
87
  (0, _defineProperty2.default)(this, "setQueryMessage", function (value) {
80
88
  _this.attributes.query_message = value;
81
89
  });
90
+ // string # The HTTP request method used by the webhook.
82
91
  (0, _defineProperty2.default)(this, "getQueryRequestMethod", function () {
83
92
  return _this.attributes.query_request_method;
84
93
  });
85
94
  (0, _defineProperty2.default)(this, "setQueryRequestMethod", function (value) {
86
95
  _this.attributes.query_request_method = value;
87
96
  });
97
+ // string # The target webhook URL.
88
98
  (0, _defineProperty2.default)(this, "getQueryRequestUrl", function () {
89
99
  return _this.attributes.query_request_url;
90
100
  });
91
101
  (0, _defineProperty2.default)(this, "setQueryRequestUrl", function (value) {
92
102
  _this.attributes.query_request_url = value;
93
103
  });
104
+ // string # The HTTP status returned from the server in response to the webhook request.
94
105
  (0, _defineProperty2.default)(this, "getQueryStatus", function () {
95
106
  return _this.attributes.query_status;
96
107
  });
97
108
  (0, _defineProperty2.default)(this, "setQueryStatus", function (value) {
98
109
  _this.attributes.query_status = value;
99
110
  });
111
+ // boolean # true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
100
112
  (0, _defineProperty2.default)(this, "getQuerySuccess", function () {
101
113
  return _this.attributes.query_success;
102
114
  });
103
115
  (0, _defineProperty2.default)(this, "setQuerySuccess", function (value) {
104
116
  _this.attributes.query_success = value;
105
117
  });
118
+ // string # If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
106
119
  (0, _defineProperty2.default)(this, "getResultsUrl", function () {
107
120
  return _this.attributes.results_url;
108
121
  });
109
122
  (0, _defineProperty2.default)(this, "setResultsUrl", function (value) {
110
123
  _this.attributes.results_url = value;
111
124
  });
125
+ // int64 # User ID. Provide a value of `0` to operate the current session's user.
112
126
  (0, _defineProperty2.default)(this, "getUserId", function () {
113
127
  return _this.attributes.user_id;
114
128
  });
@@ -137,6 +151,8 @@ var ActionNotificationExport = /*#__PURE__*/(0, _createClass2.default)(function
137
151
  });
138
152
  this.options = _objectSpread({}, options);
139
153
  });
154
+ // Parameters:
155
+ // id (required) - int64 - Action Notification Export ID.
140
156
  (0, _defineProperty2.default)(ActionNotificationExport, "find", /*#__PURE__*/function () {
141
157
  var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(id) {
142
158
  var params,
@@ -187,6 +203,17 @@ var ActionNotificationExport = /*#__PURE__*/(0, _createClass2.default)(function
187
203
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
188
204
  return ActionNotificationExport.find(id, params, options);
189
205
  });
206
+ // Parameters:
207
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
208
+ // start_at - string - Start date/time of export range.
209
+ // end_at - string - End date/time of export range.
210
+ // query_message - string - Error message associated with the request, if any.
211
+ // query_request_method - string - The HTTP request method used by the webhook.
212
+ // query_request_url - string - The target webhook URL.
213
+ // query_status - string - The HTTP status returned from the server in response to the webhook request.
214
+ // query_success - boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
215
+ // query_path - string - Return notifications that were triggered by actions on this specific path.
216
+ // query_folder - string - Return notifications that were triggered by actions in this folder.
190
217
  (0, _defineProperty2.default)(ActionNotificationExport, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
191
218
  var params,
192
219
  options,
@@ -31,33 +31,43 @@ var ActionNotificationExportResult = /*#__PURE__*/(0, _createClass2.default)(fun
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
  });
38
+ // int64 # When the notification was sent.
37
39
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
38
40
  return _this.attributes.created_at;
39
41
  });
42
+ // int64 # HTTP status code returned in the webhook response.
40
43
  (0, _defineProperty2.default)(this, "getStatus", function () {
41
44
  return _this.attributes.status;
42
45
  });
46
+ // string # A message indicating the overall status of the webhook notification.
43
47
  (0, _defineProperty2.default)(this, "getMessage", function () {
44
48
  return _this.attributes.message;
45
49
  });
50
+ // boolean # `true` if the webhook succeeded by receiving a 200 or 204 response.
46
51
  (0, _defineProperty2.default)(this, "getSuccess", function () {
47
52
  return _this.attributes.success;
48
53
  });
54
+ // string # A JSON-encoded string with headers that were sent with the webhook.
49
55
  (0, _defineProperty2.default)(this, "getRequestHeaders", function () {
50
56
  return _this.attributes.request_headers;
51
57
  });
58
+ // string # The HTTP verb used to perform the webhook.
52
59
  (0, _defineProperty2.default)(this, "getRequestMethod", function () {
53
60
  return _this.attributes.request_method;
54
61
  });
62
+ // string # The webhook request URL.
55
63
  (0, _defineProperty2.default)(this, "getRequestUrl", function () {
56
64
  return _this.attributes.request_url;
57
65
  });
66
+ // string # The path to the actual file that triggered this notification. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
58
67
  (0, _defineProperty2.default)(this, "getPath", function () {
59
68
  return _this.attributes.path;
60
69
  });
70
+ // string # The folder associated with the triggering action for this notification.
61
71
  (0, _defineProperty2.default)(this, "getFolder", function () {
62
72
  return _this.attributes.folder;
63
73
  });
@@ -74,6 +84,11 @@ var ActionNotificationExportResult = /*#__PURE__*/(0, _createClass2.default)(fun
74
84
  });
75
85
  this.options = _objectSpread({}, options);
76
86
  });
87
+ // Parameters:
88
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
89
+ // 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.
90
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
91
+ // action_notification_export_id (required) - int64 - ID of the associated action notification export.
77
92
  (0, _defineProperty2.default)(ActionNotificationExportResult, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
78
93
  var _response$data;
79
94
  var params,
@@ -31,6 +31,7 @@ var ActionWebhookFailure = /*#__PURE__*/(0, _createClass2.default)(function Acti
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // retry Action Webhook Failure
34
35
  (0, _defineProperty2.default)(this, "retry", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
35
36
  var params,
36
37
  response,
@@ -31,81 +31,99 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // int64 # API 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 # Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
40
42
  (0, _defineProperty2.default)(this, "getDescriptiveLabel", function () {
41
43
  return _this.attributes.descriptive_label;
42
44
  });
43
45
  (0, _defineProperty2.default)(this, "setDescriptiveLabel", function (value) {
44
46
  _this.attributes.descriptive_label = value;
45
47
  });
48
+ // string # User-supplied description of API key.
46
49
  (0, _defineProperty2.default)(this, "getDescription", function () {
47
50
  return _this.attributes.description;
48
51
  });
49
52
  (0, _defineProperty2.default)(this, "setDescription", function (value) {
50
53
  _this.attributes.description = value;
51
54
  });
55
+ // date-time # Time which API Key was created
52
56
  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
53
57
  return _this.attributes.created_at;
54
58
  });
59
+ // date-time # API Key expiration date
55
60
  (0, _defineProperty2.default)(this, "getExpiresAt", function () {
56
61
  return _this.attributes.expires_at;
57
62
  });
58
63
  (0, _defineProperty2.default)(this, "setExpiresAt", function (value) {
59
64
  _this.attributes.expires_at = value;
60
65
  });
66
+ // string # API Key actual key string
61
67
  (0, _defineProperty2.default)(this, "getKey", function () {
62
68
  return _this.attributes.key;
63
69
  });
64
70
  (0, _defineProperty2.default)(this, "setKey", function (value) {
65
71
  _this.attributes.key = value;
66
72
  });
73
+ // date-time # API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
67
74
  (0, _defineProperty2.default)(this, "getLastUseAt", function () {
68
75
  return _this.attributes.last_use_at;
69
76
  });
70
77
  (0, _defineProperty2.default)(this, "setLastUseAt", function (value) {
71
78
  _this.attributes.last_use_at = value;
72
79
  });
80
+ // string # Internal name for the API Key. For your use.
73
81
  (0, _defineProperty2.default)(this, "getName", function () {
74
82
  return _this.attributes.name;
75
83
  });
76
84
  (0, _defineProperty2.default)(this, "setName", function (value) {
77
85
  _this.attributes.name = value;
78
86
  });
87
+ // string # Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
79
88
  (0, _defineProperty2.default)(this, "getPath", function () {
80
89
  return _this.attributes.path;
81
90
  });
82
91
  (0, _defineProperty2.default)(this, "setPath", function (value) {
83
92
  _this.attributes.path = value;
84
93
  });
94
+ // string # Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
85
95
  (0, _defineProperty2.default)(this, "getPermissionSet", function () {
86
96
  return _this.attributes.permission_set;
87
97
  });
88
98
  (0, _defineProperty2.default)(this, "setPermissionSet", function (value) {
89
99
  _this.attributes.permission_set = value;
90
100
  });
101
+ // string # If this API key represents a Desktop app, what platform was it created on?
91
102
  (0, _defineProperty2.default)(this, "getPlatform", function () {
92
103
  return _this.attributes.platform;
93
104
  });
94
105
  (0, _defineProperty2.default)(this, "setPlatform", function (value) {
95
106
  _this.attributes.platform = value;
96
107
  });
108
+ // string # URL for API host.
97
109
  (0, _defineProperty2.default)(this, "getUrl", function () {
98
110
  return _this.attributes.url;
99
111
  });
100
112
  (0, _defineProperty2.default)(this, "setUrl", function (value) {
101
113
  _this.attributes.url = value;
102
114
  });
115
+ // int64 # User ID for the owner of this API Key. May be blank for Site-wide API Keys.
103
116
  (0, _defineProperty2.default)(this, "getUserId", function () {
104
117
  return _this.attributes.user_id;
105
118
  });
106
119
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
107
120
  _this.attributes.user_id = value;
108
121
  });
122
+ // Parameters:
123
+ // name - string - Internal name for the API Key. For your use.
124
+ // description - string - User-supplied description of API key.
125
+ // expires_at - string - API Key expiration date
126
+ // permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
109
127
  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
110
128
  var params,
111
129
  response,
@@ -260,6 +278,17 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
260
278
  });
261
279
  this.options = _objectSpread({}, options);
262
280
  });
281
+ // Parameters:
282
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
283
+ // 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.
284
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
285
+ // 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 `expires_at`.
286
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
287
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
288
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `expires_at`.
289
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
290
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
291
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `expires_at`.
263
292
  (0, _defineProperty2.default)(ApiKey, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
264
293
  var _response$data;
265
294
  var params,
@@ -326,6 +355,8 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
326
355
  }
327
356
  }, _callee4);
328
357
  })));
358
+ // Parameters:
359
+ // id (required) - int64 - Api Key ID.
329
360
  (0, _defineProperty2.default)(ApiKey, "find", /*#__PURE__*/function () {
330
361
  var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id) {
331
362
  var params,
@@ -376,6 +407,13 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
376
407
  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
377
408
  return ApiKey.find(id, params, options);
378
409
  });
410
+ // Parameters:
411
+ // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
412
+ // name - string - Internal name for the API Key. For your use.
413
+ // description - string - User-supplied description of API key.
414
+ // expires_at - string - API Key expiration date
415
+ // permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
416
+ // path - string - Folder path restriction for this api key.
379
417
  (0, _defineProperty2.default)(ApiKey, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
380
418
  var params,
381
419
  options,
@@ -433,6 +471,10 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
433
471
  }
434
472
  }, _callee6);
435
473
  })));
474
+ // Parameters:
475
+ // expires_at - string - API Key expiration date
476
+ // name - string - Internal name for the API Key. For your use.
477
+ // permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
436
478
  (0, _defineProperty2.default)(ApiKey, "updateCurrent", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
437
479
  var params,
438
480
  options,
package/lib/models/App.js CHANGED
@@ -31,51 +31,67 @@ var App = /*#__PURE__*/(0, _createClass2.default)(function App() {
31
31
  (0, _defineProperty2.default)(this, "isLoaded", function () {
32
32
  return !!_this.attributes.id;
33
33
  });
34
+ // string # Name of the App
34
35
  (0, _defineProperty2.default)(this, "getName", function () {
35
36
  return _this.attributes.name;
36
37
  });
38
+ // string # Long form description of the App
37
39
  (0, _defineProperty2.default)(this, "getExtendedDescription", function () {
38
40
  return _this.attributes.extended_description;
39
41
  });
42
+ // string # Short description of the App
40
43
  (0, _defineProperty2.default)(this, "getShortDescription", function () {
41
44
  return _this.attributes.short_description;
42
45
  });
46
+ // object # Collection of named links to documentation
43
47
  (0, _defineProperty2.default)(this, "getDocumentationLinks", function () {
44
48
  return _this.attributes.documentation_links;
45
49
  });
50
+ // string # App icon
46
51
  (0, _defineProperty2.default)(this, "getIconUrl", function () {
47
52
  return _this.attributes.icon_url;
48
53
  });
54
+ // string # Full size logo for the App
49
55
  (0, _defineProperty2.default)(this, "getLogoUrl", function () {
50
56
  return _this.attributes.logo_url;
51
57
  });
58
+ // array # Screenshots of the App
52
59
  (0, _defineProperty2.default)(this, "getScreenshotListUrls", function () {
53
60
  return _this.attributes.screenshot_list_urls;
54
61
  });
62
+ // string # Logo thumbnail for the App
55
63
  (0, _defineProperty2.default)(this, "getLogoThumbnailUrl", function () {
56
64
  return _this.attributes.logo_thumbnail_url;
57
65
  });
66
+ // string # Associated SSO Strategy type, if any
58
67
  (0, _defineProperty2.default)(this, "getSsoStrategyType", function () {
59
68
  return _this.attributes.sso_strategy_type;
60
69
  });
70
+ // string # Associated Remote Server type, if any
61
71
  (0, _defineProperty2.default)(this, "getRemoteServerType", function () {
62
72
  return _this.attributes.remote_server_type;
63
73
  });
74
+ // string # Associated Folder Behavior type, if any
64
75
  (0, _defineProperty2.default)(this, "getFolderBehaviorType", function () {
65
76
  return _this.attributes.folder_behavior_type;
66
77
  });
78
+ // string # Link to external homepage
67
79
  (0, _defineProperty2.default)(this, "getExternalHomepageUrl", function () {
68
80
  return _this.attributes.external_homepage_url;
69
81
  });
82
+ // string # Marketing video page
70
83
  (0, _defineProperty2.default)(this, "getMarketingYoutubeUrl", function () {
71
84
  return _this.attributes.marketing_youtube_url;
72
85
  });
86
+ // string # Tutorial video page
73
87
  (0, _defineProperty2.default)(this, "getTutorialYoutubeUrl", function () {
74
88
  return _this.attributes.tutorial_youtube_url;
75
89
  });
90
+ // string # The type of the App
76
91
  (0, _defineProperty2.default)(this, "getAppType", function () {
77
92
  return _this.attributes.app_type;
78
93
  });
94
+ // boolean # Is featured on the App listing?
79
95
  (0, _defineProperty2.default)(this, "getFeatured", function () {
80
96
  return _this.attributes.featured;
81
97
  });
@@ -92,6 +108,16 @@ var App = /*#__PURE__*/(0, _createClass2.default)(function App() {
92
108
  });
93
109
  this.options = _objectSpread({}, options);
94
110
  });
111
+ // Parameters:
112
+ // 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.
113
+ // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
114
+ // sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
115
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
116
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
117
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
118
+ // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
119
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
120
+ // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
95
121
  (0, _defineProperty2.default)(App, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
96
122
  var _response$data;
97
123
  var params,