files.com 1.2.86 → 1.2.87

Sign up to get free protection for your applications and to get access to all the features.
Files changed (211) hide show
  1. package/_VERSION +1 -1
  2. package/docs/models/ActionNotificationExportResult.md +3 -0
  3. package/docs/models/ApiKey.md +6 -0
  4. package/docs/models/ApiRequestLog.md +3 -0
  5. package/docs/models/App.md +3 -0
  6. package/docs/models/As2IncomingMessage.md +3 -0
  7. package/docs/models/As2OutgoingMessage.md +3 -0
  8. package/docs/models/As2Partner.md +42 -29
  9. package/docs/models/As2Station.md +3 -0
  10. package/docs/models/Automation.md +17 -3
  11. package/docs/models/AutomationLog.md +3 -0
  12. package/docs/models/AutomationRun.md +3 -0
  13. package/docs/models/BandwidthSnapshot.md +3 -0
  14. package/docs/models/Behavior.md +26 -19
  15. package/docs/models/Bundle.md +4 -5
  16. package/docs/models/BundleAction.md +4 -0
  17. package/docs/models/BundleDownload.md +3 -0
  18. package/docs/models/BundleNotification.md +3 -0
  19. package/docs/models/BundleRecipient.md +3 -0
  20. package/docs/models/BundleRegistration.md +3 -0
  21. package/docs/models/Clickwrap.md +3 -0
  22. package/docs/models/DnsRecord.md +3 -0
  23. package/docs/models/EmailIncomingMessage.md +3 -0
  24. package/docs/models/EmailLog.md +3 -0
  25. package/docs/models/ExavaultApiRequestLog.md +3 -0
  26. package/docs/models/ExternalEvent.md +3 -0
  27. package/docs/models/FileComment.md +3 -0
  28. package/docs/models/FileMigration.md +1 -1
  29. package/docs/models/FileMigrationLog.md +3 -0
  30. package/docs/models/Folder.md +2 -0
  31. package/docs/models/FormFieldSet.md +3 -0
  32. package/docs/models/FtpActionLog.md +3 -0
  33. package/docs/models/GpgKey.md +3 -0
  34. package/docs/models/Group.md +3 -0
  35. package/docs/models/GroupUser.md +3 -0
  36. package/docs/models/History.md +20 -0
  37. package/docs/models/HistoryExportResult.md +4 -0
  38. package/docs/models/InboxRecipient.md +3 -0
  39. package/docs/models/InboxRegistration.md +3 -0
  40. package/docs/models/InboxUpload.md +3 -0
  41. package/docs/models/Invoice.md +3 -0
  42. package/docs/models/IpAddress.md +12 -0
  43. package/docs/models/Lock.md +6 -3
  44. package/docs/models/Message.md +3 -0
  45. package/docs/models/MessageComment.md +3 -0
  46. package/docs/models/MessageCommentReaction.md +3 -0
  47. package/docs/models/MessageReaction.md +3 -0
  48. package/docs/models/Notification.md +4 -1
  49. package/docs/models/Payment.md +3 -0
  50. package/docs/models/Permission.md +3 -0
  51. package/docs/models/Priority.md +3 -0
  52. package/docs/models/Project.md +3 -0
  53. package/docs/models/PublicHostingRequestLog.md +3 -0
  54. package/docs/models/PublicKey.md +3 -0
  55. package/docs/models/RemoteBandwidthSnapshot.md +3 -0
  56. package/docs/models/RemoteServer.md +3 -0
  57. package/docs/models/Request.md +6 -0
  58. package/docs/models/SettingsChange.md +3 -0
  59. package/docs/models/SftpActionLog.md +3 -0
  60. package/docs/models/SftpHostKey.md +3 -0
  61. package/docs/models/ShareGroup.md +3 -0
  62. package/docs/models/Snapshot.md +3 -0
  63. package/docs/models/SsoStrategy.md +4 -1
  64. package/docs/models/SyncLog.md +3 -0
  65. package/docs/models/UsageDailySnapshot.md +3 -0
  66. package/docs/models/UsageSnapshot.md +3 -0
  67. package/docs/models/User.md +6 -3
  68. package/docs/models/UserCipherUse.md +3 -0
  69. package/docs/models/UserRequest.md +3 -0
  70. package/docs/models/WebDavActionLog.md +3 -0
  71. package/lib/Files.js +1 -1
  72. package/lib/models/ActionNotificationExportResult.js +19 -5
  73. package/lib/models/ApiKey.js +34 -6
  74. package/lib/models/ApiRequestLog.js +17 -3
  75. package/lib/models/App.js +17 -3
  76. package/lib/models/As2IncomingMessage.js +19 -5
  77. package/lib/models/As2OutgoingMessage.js +19 -5
  78. package/lib/models/As2Partner.js +120 -64
  79. package/lib/models/As2Station.js +17 -3
  80. package/lib/models/Automation.js +31 -6
  81. package/lib/models/AutomationLog.js +17 -3
  82. package/lib/models/AutomationRun.js +19 -5
  83. package/lib/models/BandwidthSnapshot.js +17 -3
  84. package/lib/models/Behavior.js +53 -31
  85. package/lib/models/Bundle.js +18 -6
  86. package/lib/models/BundleAction.js +21 -7
  87. package/lib/models/BundleDownload.js +21 -7
  88. package/lib/models/BundleNotification.js +17 -3
  89. package/lib/models/BundleRecipient.js +19 -5
  90. package/lib/models/BundleRegistration.js +19 -5
  91. package/lib/models/Clickwrap.js +17 -3
  92. package/lib/models/DnsRecord.js +17 -3
  93. package/lib/models/EmailIncomingMessage.js +17 -3
  94. package/lib/models/EmailLog.js +17 -3
  95. package/lib/models/ExavaultApiRequestLog.js +17 -3
  96. package/lib/models/ExternalEvent.js +17 -3
  97. package/lib/models/FileComment.js +19 -5
  98. package/lib/models/FileMigration.js +1 -1
  99. package/lib/models/FileMigrationLog.js +17 -3
  100. package/lib/models/Folder.js +18 -11
  101. package/lib/models/FormFieldSet.js +17 -3
  102. package/lib/models/FtpActionLog.js +17 -3
  103. package/lib/models/GpgKey.js +17 -3
  104. package/lib/models/Group.js +19 -5
  105. package/lib/models/GroupUser.js +19 -5
  106. package/lib/models/History.js +91 -21
  107. package/lib/models/HistoryExportResult.js +19 -5
  108. package/lib/models/InboxRecipient.js +19 -5
  109. package/lib/models/InboxRegistration.js +19 -5
  110. package/lib/models/InboxUpload.js +21 -7
  111. package/lib/models/Invoice.js +17 -3
  112. package/lib/models/IpAddress.js +68 -12
  113. package/lib/models/Lock.js +22 -8
  114. package/lib/models/Message.js +19 -5
  115. package/lib/models/MessageComment.js +19 -5
  116. package/lib/models/MessageCommentReaction.js +19 -5
  117. package/lib/models/MessageReaction.js +19 -5
  118. package/lib/models/Notification.js +22 -8
  119. package/lib/models/Payment.js +17 -3
  120. package/lib/models/Permission.js +23 -9
  121. package/lib/models/Priority.js +19 -5
  122. package/lib/models/Project.js +17 -3
  123. package/lib/models/PublicHostingRequestLog.js +17 -3
  124. package/lib/models/PublicKey.js +17 -3
  125. package/lib/models/RemoteBandwidthSnapshot.js +17 -3
  126. package/lib/models/RemoteServer.js +17 -3
  127. package/lib/models/Request.js +38 -10
  128. package/lib/models/SettingsChange.js +17 -3
  129. package/lib/models/SftpActionLog.js +17 -3
  130. package/lib/models/SftpHostKey.js +17 -3
  131. package/lib/models/ShareGroup.js +17 -3
  132. package/lib/models/Snapshot.js +17 -3
  133. package/lib/models/SsoStrategy.js +18 -4
  134. package/lib/models/SyncLog.js +17 -3
  135. package/lib/models/UsageDailySnapshot.js +17 -3
  136. package/lib/models/UsageSnapshot.js +17 -3
  137. package/lib/models/User.js +24 -10
  138. package/lib/models/UserCipherUse.js +17 -3
  139. package/lib/models/UserRequest.js +17 -3
  140. package/lib/models/WebDavActionLog.js +17 -3
  141. package/package.json +1 -1
  142. package/src/Files.js +1 -1
  143. package/src/models/ActionNotificationExportResult.js +10 -0
  144. package/src/models/ApiKey.js +22 -0
  145. package/src/models/ApiRequestLog.js +10 -0
  146. package/src/models/App.js +10 -0
  147. package/src/models/As2IncomingMessage.js +10 -0
  148. package/src/models/As2OutgoingMessage.js +10 -0
  149. package/src/models/As2Partner.js +82 -38
  150. package/src/models/As2Station.js +10 -0
  151. package/src/models/Automation.js +24 -3
  152. package/src/models/AutomationLog.js +10 -0
  153. package/src/models/AutomationRun.js +10 -0
  154. package/src/models/BandwidthSnapshot.js +10 -0
  155. package/src/models/Behavior.js +39 -23
  156. package/src/models/Bundle.js +11 -3
  157. package/src/models/BundleAction.js +10 -0
  158. package/src/models/BundleDownload.js +10 -0
  159. package/src/models/BundleNotification.js +10 -0
  160. package/src/models/BundleRecipient.js +10 -0
  161. package/src/models/BundleRegistration.js +10 -0
  162. package/src/models/Clickwrap.js +10 -0
  163. package/src/models/DnsRecord.js +10 -0
  164. package/src/models/EmailIncomingMessage.js +10 -0
  165. package/src/models/EmailLog.js +10 -0
  166. package/src/models/ExavaultApiRequestLog.js +10 -0
  167. package/src/models/ExternalEvent.js +10 -0
  168. package/src/models/FileComment.js +10 -0
  169. package/src/models/FileMigration.js +1 -1
  170. package/src/models/FileMigrationLog.js +10 -0
  171. package/src/models/Folder.js +5 -0
  172. package/src/models/FormFieldSet.js +10 -0
  173. package/src/models/FtpActionLog.js +10 -0
  174. package/src/models/GpgKey.js +10 -0
  175. package/src/models/Group.js +10 -0
  176. package/src/models/GroupUser.js +10 -0
  177. package/src/models/History.js +50 -0
  178. package/src/models/HistoryExportResult.js +10 -0
  179. package/src/models/InboxRecipient.js +10 -0
  180. package/src/models/InboxRegistration.js +10 -0
  181. package/src/models/InboxUpload.js +10 -0
  182. package/src/models/Invoice.js +10 -0
  183. package/src/models/IpAddress.js +40 -0
  184. package/src/models/Lock.js +13 -3
  185. package/src/models/Message.js +10 -0
  186. package/src/models/MessageComment.js +10 -0
  187. package/src/models/MessageCommentReaction.js +10 -0
  188. package/src/models/MessageReaction.js +10 -0
  189. package/src/models/Notification.js +11 -1
  190. package/src/models/Payment.js +10 -0
  191. package/src/models/Permission.js +10 -0
  192. package/src/models/Priority.js +10 -0
  193. package/src/models/Project.js +10 -0
  194. package/src/models/PublicHostingRequestLog.js +10 -0
  195. package/src/models/PublicKey.js +10 -0
  196. package/src/models/RemoteBandwidthSnapshot.js +10 -0
  197. package/src/models/RemoteServer.js +10 -0
  198. package/src/models/Request.js +20 -0
  199. package/src/models/SettingsChange.js +10 -0
  200. package/src/models/SftpActionLog.js +10 -0
  201. package/src/models/SftpHostKey.js +10 -0
  202. package/src/models/ShareGroup.js +10 -0
  203. package/src/models/Snapshot.js +10 -0
  204. package/src/models/SsoStrategy.js +11 -1
  205. package/src/models/SyncLog.js +10 -0
  206. package/src/models/UsageDailySnapshot.js +10 -0
  207. package/src/models/UsageSnapshot.js +10 -0
  208. package/src/models/User.js +13 -3
  209. package/src/models/UserCipherUse.js +10 -0
  210. package/src/models/UserRequest.js +10 -0
  211. package/src/models/WebDavActionLog.js +10 -0
@@ -58,6 +58,8 @@ class AutomationLog {
58
58
  // Parameters:
59
59
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
+ // action - string
62
+ // page - int64
61
63
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `automation_id`, `automation_run_id`, `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
62
64
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
63
65
  static list = async (params = {}, options = {}) => {
@@ -69,6 +71,14 @@ class AutomationLog {
69
71
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
70
72
  }
71
73
 
74
+ if (params.action && !isString(params.action)) {
75
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
76
+ }
77
+
78
+ if (params.page && !isInt(params.page)) {
79
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
80
+ }
81
+
72
82
  const response = await Api.sendRequest('/automation_logs', 'GET', params, options)
73
83
 
74
84
  return response?.data?.map(obj => new AutomationLog(obj, options)) || []
@@ -58,6 +58,8 @@ class AutomationRun {
58
58
  // Parameters:
59
59
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
+ // action - string
62
+ // page - int64
61
63
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
62
64
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
63
65
  // automation_id (required) - int64 - ID of the associated Automation.
@@ -74,6 +76,14 @@ class AutomationRun {
74
76
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
75
77
  }
76
78
 
79
+ if (params.action && !isString(params.action)) {
80
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
81
+ }
82
+
83
+ if (params.page && !isInt(params.page)) {
84
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
85
+ }
86
+
77
87
  if (params.automation_id && !isInt(params.automation_id)) {
78
88
  throw new errors.InvalidParameterError(`Bad parameter: automation_id must be of type Int, received ${getType(params.automation_id)}`)
79
89
  }
@@ -58,6 +58,8 @@ class BandwidthSnapshot {
58
58
  // Parameters:
59
59
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
+ // action - string
62
+ // page - int64
61
63
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
62
64
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
63
65
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
@@ -73,6 +75,14 @@ class BandwidthSnapshot {
73
75
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
74
76
  }
75
77
 
78
+ if (params.action && !isString(params.action)) {
79
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
80
+ }
81
+
82
+ if (params.page && !isInt(params.page)) {
83
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
84
+ }
85
+
76
86
  const response = await Api.sendRequest('/bandwidth_snapshots', 'GET', params, options)
77
87
 
78
88
  return response?.data?.map(obj => new BandwidthSnapshot(obj, options)) || []
@@ -91,14 +91,14 @@ class Behavior {
91
91
  this.attributes.recursive = value
92
92
  }
93
93
 
94
- // file # Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
94
+ // file # Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
95
95
  getAttachmentFile = () => this.attributes.attachment_file
96
96
 
97
97
  setAttachmentFile = value => {
98
98
  this.attributes.attachment_file = value
99
99
  }
100
100
 
101
- // boolean # If true, will delete the file stored in attachment
101
+ // boolean # If `true`, delete the file stored in `attachment`.
102
102
  getAttachmentDelete = () => this.attributes.attachment_delete
103
103
 
104
104
  setAttachmentDelete = value => {
@@ -106,13 +106,13 @@ class Behavior {
106
106
  }
107
107
 
108
108
  // Parameters:
109
- // value - string - The value of the folder behavior. Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
110
- // attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
111
- // disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder and its children.
112
- // recursive - boolean - Is behavior recursive?
109
+ // value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
110
+ // attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
111
+ // disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
112
+ // recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
113
113
  // name - string - Name for this behavior.
114
114
  // description - string - Description for this behavior.
115
- // attachment_delete - boolean - If true, will delete the file stored in attachment
115
+ // attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
116
116
  update = async (params = {}) => {
117
117
  if (!this.attributes.id) {
118
118
  throw new errors.EmptyPropertyError('Current object has no id')
@@ -195,6 +195,8 @@ class Behavior {
195
195
  // Parameters:
196
196
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
197
197
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
198
+ // action - string
199
+ // page - int64
198
200
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
199
201
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
200
202
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
@@ -207,6 +209,14 @@ class Behavior {
207
209
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
208
210
  }
209
211
 
212
+ if (params.action && !isString(params.action)) {
213
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
214
+ }
215
+
216
+ if (params.page && !isInt(params.page)) {
217
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
218
+ }
219
+
210
220
  const response = await Api.sendRequest('/behaviors', 'GET', params, options)
211
221
 
212
222
  return response?.data?.map(obj => new Behavior(obj, options)) || []
@@ -243,12 +253,14 @@ class Behavior {
243
253
  // Parameters:
244
254
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
245
255
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
256
+ // action - string
257
+ // page - int64
246
258
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
247
259
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
248
260
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
249
261
  // path (required) - string - Path to operate on.
250
- // ancestor_behaviors - string - Show behaviors above this path?
251
- // behavior - string - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
262
+ // ancestor_behaviors - boolean - If `true`, behaviors above this path are shown.
263
+ // behavior - string
252
264
  static listFor = async (path, params = {}, options = {}) => {
253
265
  if (!isObject(params)) {
254
266
  throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
@@ -268,12 +280,16 @@ class Behavior {
268
280
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
269
281
  }
270
282
 
271
- if (params.path && !isString(params.path)) {
272
- throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params.path)}`)
283
+ if (params.action && !isString(params.action)) {
284
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
273
285
  }
274
286
 
275
- if (params.ancestor_behaviors && !isString(params.ancestor_behaviors)) {
276
- throw new errors.InvalidParameterError(`Bad parameter: ancestor_behaviors must be of type String, received ${getType(params.ancestor_behaviors)}`)
287
+ if (params.page && !isInt(params.page)) {
288
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
289
+ }
290
+
291
+ if (params.path && !isString(params.path)) {
292
+ throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params.path)}`)
277
293
  }
278
294
 
279
295
  if (params.behavior && !isString(params.behavior)) {
@@ -286,13 +302,13 @@ class Behavior {
286
302
  }
287
303
 
288
304
  // Parameters:
289
- // value - string - The value of the folder behavior. Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
290
- // attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
291
- // disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder and its children.
292
- // recursive - boolean - Is behavior recursive?
305
+ // value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
306
+ // attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
307
+ // disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
308
+ // recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
293
309
  // name - string - Name for this behavior.
294
310
  // description - string - Description for this behavior.
295
- // path (required) - string - Folder behaviors path.
311
+ // path (required) - string - Path where this behavior should apply.
296
312
  // behavior (required) - string - Behavior type.
297
313
  static create = async (params = {}, options = {}) => {
298
314
  if (!params.path) {
@@ -330,11 +346,11 @@ class Behavior {
330
346
 
331
347
  // Parameters:
332
348
  // url (required) - string - URL for testing the webhook.
333
- // method - string - HTTP method(GET or POST).
334
- // encoding - string - HTTP encoding method. Can be JSON, XML, or RAW (form data).
335
- // headers - object - Additional request headers.
336
- // body - object - Additional body parameters.
337
- // action - string - action for test body
349
+ // method - string - HTTP request method (GET or POST).
350
+ // encoding - string - Encoding type for the webhook payload. Can be JSON, XML, or RAW (form data).
351
+ // headers - object - Additional request headers to send via HTTP.
352
+ // body - object - Additional body parameters to include in the webhook payload.
353
+ // action - string - Action for test body.
338
354
  static webhookTest = async (params = {}, options = {}) => {
339
355
  if (!params.url) {
340
356
  throw new errors.MissingParameterError('Parameter missing: url')
@@ -105,7 +105,7 @@ class Bundle {
105
105
  this.attributes.permissions = value
106
106
  }
107
107
 
108
- // boolean # DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
108
+ // boolean
109
109
  getPreviewOnly = () => this.attributes.preview_only
110
110
 
111
111
  setPreviewOnly = value => {
@@ -399,7 +399,6 @@ class Bundle {
399
399
  // path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
400
400
  // path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
401
401
  // permissions - string - Permissions that apply to Folders in this Share Link.
402
- // preview_only - boolean - DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
403
402
  // require_registration - boolean - Show a registration page that captures the downloader's name and email address?
404
403
  // require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
405
404
  // send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
@@ -536,6 +535,8 @@ class Bundle {
536
535
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
537
536
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
538
537
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
538
+ // action - string
539
+ // page - int64
539
540
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `code`.
540
541
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
541
542
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
@@ -555,6 +556,14 @@ class Bundle {
555
556
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
556
557
  }
557
558
 
559
+ if (params.action && !isString(params.action)) {
560
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
561
+ }
562
+
563
+ if (params.page && !isInt(params.page)) {
564
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
565
+ }
566
+
558
567
  const response = await Api.sendRequest('/bundles', 'GET', params, options)
559
568
 
560
569
  return response?.data?.map(obj => new Bundle(obj, options)) || []
@@ -604,7 +613,6 @@ class Bundle {
604
613
  // path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
605
614
  // path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
606
615
  // permissions - string - Permissions that apply to Folders in this Share Link.
607
- // preview_only - boolean - DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
608
616
  // require_registration - boolean - Show a registration page that captures the downloader's name and email address?
609
617
  // clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
610
618
  // inbox_id - int64 - ID of the associated inbox, if available.
@@ -49,6 +49,8 @@ class BundleAction {
49
49
  // Parameters:
50
50
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
51
51
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
+ // action - string
53
+ // page - int64
52
54
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
53
55
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
54
56
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
@@ -66,6 +68,14 @@ class BundleAction {
66
68
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
67
69
  }
68
70
 
71
+ if (params.action && !isString(params.action)) {
72
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
73
+ }
74
+
75
+ if (params.page && !isInt(params.page)) {
76
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
77
+ }
78
+
69
79
  if (params.bundle_id && !isInt(params.bundle_id)) {
70
80
  throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params.bundle_id)}`)
71
81
  }
@@ -43,6 +43,8 @@ class BundleDownload {
43
43
  // Parameters:
44
44
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
45
45
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
+ // action - string
47
+ // page - int64
46
48
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
47
49
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
48
50
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
@@ -60,6 +62,14 @@ class BundleDownload {
60
62
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
61
63
  }
62
64
 
65
+ if (params.action && !isString(params.action)) {
66
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
67
+ }
68
+
69
+ if (params.page && !isInt(params.page)) {
70
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
71
+ }
72
+
63
73
  if (params.bundle_id && !isInt(params.bundle_id)) {
64
74
  throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params.bundle_id)}`)
65
75
  }
@@ -136,6 +136,8 @@ class BundleNotification {
136
136
  // Parameters:
137
137
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
138
138
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
139
+ // action - string
140
+ // page - int64
139
141
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_id]=desc`). Valid fields are `bundle_id`.
140
142
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
141
143
  static list = async (params = {}, options = {}) => {
@@ -147,6 +149,14 @@ class BundleNotification {
147
149
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
148
150
  }
149
151
 
152
+ if (params.action && !isString(params.action)) {
153
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
154
+ }
155
+
156
+ if (params.page && !isInt(params.page)) {
157
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
158
+ }
159
+
150
160
  const response = await Api.sendRequest('/bundle_notifications', 'GET', params, options)
151
161
 
152
162
  return response?.data?.map(obj => new BundleNotification(obj, options)) || []
@@ -90,6 +90,8 @@ class BundleRecipient {
90
90
  // Parameters:
91
91
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
92
92
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
93
+ // action - string
94
+ // page - int64
93
95
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
94
96
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
95
97
  // bundle_id (required) - int64 - List recipients for the bundle with this ID.
@@ -106,6 +108,14 @@ class BundleRecipient {
106
108
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
107
109
  }
108
110
 
111
+ if (params.action && !isString(params.action)) {
112
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
113
+ }
114
+
115
+ if (params.page && !isInt(params.page)) {
116
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
117
+ }
118
+
109
119
  if (params.bundle_id && !isInt(params.bundle_id)) {
110
120
  throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params.bundle_id)}`)
111
121
  }
@@ -70,6 +70,8 @@ class BundleRegistration {
70
70
  // Parameters:
71
71
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
72
72
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
73
+ // action - string
74
+ // page - int64
73
75
  // bundle_id - int64 - ID of the associated Bundle
74
76
  static list = async (params = {}, options = {}) => {
75
77
  if (params.cursor && !isString(params.cursor)) {
@@ -80,6 +82,14 @@ class BundleRegistration {
80
82
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
81
83
  }
82
84
 
85
+ if (params.action && !isString(params.action)) {
86
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
87
+ }
88
+
89
+ if (params.page && !isInt(params.page)) {
90
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
91
+ }
92
+
83
93
  if (params.bundle_id && !isInt(params.bundle_id)) {
84
94
  throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params.bundle_id)}`)
85
95
  }
@@ -166,6 +166,8 @@ class Clickwrap {
166
166
  // Parameters:
167
167
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
168
168
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
169
+ // action - string
170
+ // page - int64
169
171
  static list = async (params = {}, options = {}) => {
170
172
  if (params.cursor && !isString(params.cursor)) {
171
173
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
@@ -175,6 +177,14 @@ class Clickwrap {
175
177
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
176
178
  }
177
179
 
180
+ if (params.action && !isString(params.action)) {
181
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
182
+ }
183
+
184
+ if (params.page && !isInt(params.page)) {
185
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
186
+ }
187
+
178
188
  const response = await Api.sendRequest('/clickwraps', 'GET', params, options)
179
189
 
180
190
  return response?.data?.map(obj => new Clickwrap(obj, options)) || []
@@ -43,6 +43,8 @@ class DnsRecord {
43
43
  // Parameters:
44
44
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
45
45
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
+ // action - string
47
+ // page - int64
46
48
  static list = async (params = {}, options = {}) => {
47
49
  if (params.cursor && !isString(params.cursor)) {
48
50
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
@@ -52,6 +54,14 @@ class DnsRecord {
52
54
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
53
55
  }
54
56
 
57
+ if (params.action && !isString(params.action)) {
58
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
59
+ }
60
+
61
+ if (params.page && !isInt(params.page)) {
62
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
63
+ }
64
+
55
65
  const response = await Api.sendRequest('/dns_records', 'GET', params, options)
56
66
 
57
67
  return response?.data?.map(obj => new DnsRecord(obj, options)) || []
@@ -58,6 +58,8 @@ class EmailIncomingMessage {
58
58
  // Parameters:
59
59
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
+ // action - string
62
+ // page - int64
61
63
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
62
64
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
63
65
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
@@ -74,6 +76,14 @@ class EmailIncomingMessage {
74
76
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
75
77
  }
76
78
 
79
+ if (params.action && !isString(params.action)) {
80
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
81
+ }
82
+
83
+ if (params.page && !isInt(params.page)) {
84
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
85
+ }
86
+
77
87
  const response = await Api.sendRequest('/email_incoming_messages', 'GET', params, options)
78
88
 
79
89
  return response?.data?.map(obj => new EmailIncomingMessage(obj, options)) || []
@@ -58,6 +58,8 @@ class EmailLog {
58
58
  // Parameters:
59
59
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
+ // action - string
62
+ // page - int64
61
63
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
62
64
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
63
65
  static list = async (params = {}, options = {}) => {
@@ -69,6 +71,14 @@ class EmailLog {
69
71
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
70
72
  }
71
73
 
74
+ if (params.action && !isString(params.action)) {
75
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
76
+ }
77
+
78
+ if (params.page && !isInt(params.page)) {
79
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
80
+ }
81
+
72
82
  const response = await Api.sendRequest('/email_logs', 'GET', params, options)
73
83
 
74
84
  return response?.data?.map(obj => new EmailLog(obj, options)) || []
@@ -64,6 +64,8 @@ class ExavaultApiRequestLog {
64
64
  // Parameters:
65
65
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
66
66
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
67
+ // action - string
68
+ // page - int64
67
69
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
68
70
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
69
71
  static list = async (params = {}, options = {}) => {
@@ -75,6 +77,14 @@ class ExavaultApiRequestLog {
75
77
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
76
78
  }
77
79
 
80
+ if (params.action && !isString(params.action)) {
81
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
82
+ }
83
+
84
+ if (params.page && !isInt(params.page)) {
85
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
86
+ }
87
+
78
88
  const response = await Api.sendRequest('/exavault_api_request_logs', 'GET', params, options)
79
89
 
80
90
  return response?.data?.map(obj => new ExavaultApiRequestLog(obj, options)) || []
@@ -128,6 +128,8 @@ class ExternalEvent {
128
128
  // Parameters:
129
129
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
130
130
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
131
+ // action - string
132
+ // page - int64
131
133
  // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[remote_server_type]=desc`). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
132
134
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
133
135
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
@@ -144,6 +146,14 @@ class ExternalEvent {
144
146
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
145
147
  }
146
148
 
149
+ if (params.action && !isString(params.action)) {
150
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
151
+ }
152
+
153
+ if (params.page && !isInt(params.page)) {
154
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
155
+ }
156
+
147
157
  const response = await Api.sendRequest('/external_events', 'GET', params, options)
148
158
 
149
159
  return response?.data?.map(obj => new ExternalEvent(obj, options)) || []
@@ -140,6 +140,8 @@ class FileComment {
140
140
  // Parameters:
141
141
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
142
142
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
143
+ // action - string
144
+ // page - int64
143
145
  // path (required) - string - Path to operate on.
144
146
  static listFor = async (path, params = {}, options = {}) => {
145
147
  if (!isObject(params)) {
@@ -160,6 +162,14 @@ class FileComment {
160
162
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
161
163
  }
162
164
 
165
+ if (params.action && !isString(params.action)) {
166
+ throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
167
+ }
168
+
169
+ if (params.page && !isInt(params.page)) {
170
+ throw new errors.InvalidParameterError(`Bad parameter: page must be of type Int, received ${getType(params.page)}`)
171
+ }
172
+
163
173
  if (params.path && !isString(params.path)) {
164
174
  throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params.path)}`)
165
175
  }
@@ -40,7 +40,7 @@ class FileMigration {
40
40
  // int64 # Number of files processed
41
41
  getFilesMoved = () => this.attributes.files_moved
42
42
 
43
- // int64 # Deprecated: used to return a count of the applicable files. Currently returns 0 always. On remote servers, it is not possible to reliably determine the number of affected files for every migration operation.
43
+ // int64
44
44
  getFilesTotal = () => this.attributes.files_total
45
45
 
46
46
  // string # The type of operation