files.com 1.1.670 → 1.1.671

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (345) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account.md +155 -0
  4. data/docs/action_log.md +21 -1
  5. data/docs/action_notification_export_result.md +17 -0
  6. data/docs/action_webhook_failure.md +28 -0
  7. data/docs/agent_proxy_identity.md +49 -0
  8. data/docs/agent_proxy_identity_endpoint.md +11 -0
  9. data/docs/agent_proxy_identity_result.md +24 -0
  10. data/docs/agent_v2_auth.md +17 -0
  11. data/docs/ai_assistant_personality.md +14 -0
  12. data/docs/ai_task.md +14 -0
  13. data/docs/announcement.md +57 -0
  14. data/docs/api_key.md +27 -1
  15. data/docs/api_request_log.md +21 -1
  16. data/docs/app.md +15 -0
  17. data/docs/as2_incoming_message.md +18 -0
  18. data/docs/as2_outgoing_message.md +18 -0
  19. data/docs/as2_partner.md +14 -0
  20. data/docs/as2_station.md +14 -0
  21. data/docs/automation.md +22 -1
  22. data/docs/automation_log.md +21 -1
  23. data/docs/automation_run.md +19 -0
  24. data/docs/bandwidth_snapshot.md +18 -0
  25. data/docs/behavior.md +14 -0
  26. data/docs/blog_post.md +57 -0
  27. data/docs/bundle.md +50 -1
  28. data/docs/bundle_action.md +25 -0
  29. data/docs/bundle_download.md +23 -0
  30. data/docs/bundle_notification.md +19 -0
  31. data/docs/bundle_recipient.md +21 -0
  32. data/docs/bundle_recipient_registration.md +39 -0
  33. data/docs/bundle_registration.md +61 -0
  34. data/docs/certificate.md +258 -0
  35. data/docs/chat_session.md +14 -0
  36. data/docs/child_site.md +583 -0
  37. data/docs/child_site_management_policy.md +9 -0
  38. data/docs/clickwrap.md +13 -0
  39. data/docs/clickwrap_acceptance.md +30 -0
  40. data/docs/client_log.md +17 -0
  41. data/docs/crash_report.md +50 -0
  42. data/docs/custom_domain.md +13 -0
  43. data/docs/custom_domain_for_proxy.md +23 -0
  44. data/docs/desktop_configuration_profile.md +14 -0
  45. data/docs/dns_record.md +9 -0
  46. data/docs/email_incoming_message.md +19 -0
  47. data/docs/email_log.md +20 -1
  48. data/docs/email_preference.md +108 -0
  49. data/docs/email_preference_bundle_notification.md +15 -0
  50. data/docs/email_preference_notification.md +17 -0
  51. data/docs/event_channel.md +14 -0
  52. data/docs/event_delivery_attempt.md +14 -0
  53. data/docs/event_record.md +19 -0
  54. data/docs/event_subscription.md +14 -0
  55. data/docs/event_target.md +14 -0
  56. data/docs/exavault_api_request_log.md +21 -1
  57. data/docs/expectation.md +14 -0
  58. data/docs/expectation_evaluation.md +14 -0
  59. data/docs/expectation_incident.md +14 -0
  60. data/docs/export.md +90 -0
  61. data/docs/external_event.md +18 -0
  62. data/docs/file.md +90 -2
  63. data/docs/file_migration.md +32 -0
  64. data/docs/file_migration_log.md +20 -1
  65. data/docs/file_upload_part.md +3 -1
  66. data/docs/folder.md +20 -0
  67. data/docs/form_field_set.md +15 -0
  68. data/docs/front_end_server.md +111 -0
  69. data/docs/frontend_metric.md +34 -0
  70. data/docs/ftp_action_log.md +21 -1
  71. data/docs/gpg_key.md +21 -0
  72. data/docs/group.md +19 -0
  73. data/docs/group_user.md +22 -2
  74. data/docs/history.md +85 -0
  75. data/docs/history_export_result.md +17 -0
  76. data/docs/holiday_region.md +9 -0
  77. data/docs/inbound_s3_log.md +21 -1
  78. data/docs/inbox.md +102 -0
  79. data/docs/inbox_recipient.md +19 -0
  80. data/docs/inbox_recipient_registration.md +35 -0
  81. data/docs/inbox_registration.md +57 -0
  82. data/docs/inbox_upload.md +18 -0
  83. data/docs/invoice.md +9 -0
  84. data/docs/ip.md +63 -0
  85. data/docs/ip_abuse_entry.md +47 -0
  86. data/docs/ip_address.md +59 -0
  87. data/docs/key_lifecycle_rule.md +14 -0
  88. data/docs/label.md +9 -0
  89. data/docs/lead.md +161 -0
  90. data/docs/lock.md +15 -0
  91. data/docs/message.md +17 -0
  92. data/docs/message_comment.md +18 -0
  93. data/docs/message_comment_reaction.md +18 -0
  94. data/docs/message_reaction.md +17 -0
  95. data/docs/metadata_category.md +13 -0
  96. data/docs/monitoring_stat.md +38 -0
  97. data/docs/monitoring_stats.md +15 -0
  98. data/docs/mover_package.md +68 -0
  99. data/docs/notification.md +20 -0
  100. data/docs/nps_response.md +75 -0
  101. data/docs/oauth_redirect.md +11 -0
  102. data/docs/outbound_connection_log.md +21 -1
  103. data/docs/paired_api_key.md +19 -0
  104. data/docs/partner.md +14 -0
  105. data/docs/partner_channel.md +14 -0
  106. data/docs/partner_site_request.md +14 -0
  107. data/docs/payment.md +9 -0
  108. data/docs/paypal_express_info.md +31 -0
  109. data/docs/paypal_express_url.md +11 -0
  110. data/docs/pending_work_event.md +18 -0
  111. data/docs/permission.md +22 -0
  112. data/docs/plan.md +107 -0
  113. data/docs/preview.md +57 -0
  114. data/docs/project.md +9 -0
  115. data/docs/public_hosting_request_log.md +21 -1
  116. data/docs/public_hosting_session_pairing.md +15 -0
  117. data/docs/public_inbox.md +121 -0
  118. data/docs/public_key.md +21 -0
  119. data/docs/public_url.md +59 -0
  120. data/docs/regional_migration.md +0 -0
  121. data/docs/release.md +83 -0
  122. data/docs/release_package.md +19 -0
  123. data/docs/remote_bandwidth_snapshot.md +18 -0
  124. data/docs/remote_mount_backend.md +13 -0
  125. data/docs/remote_server.md +233 -0
  126. data/docs/remote_server_credential.md +15 -0
  127. data/docs/request.md +17 -0
  128. data/docs/restore.md +14 -0
  129. data/docs/revision.md +40 -0
  130. data/docs/safe_plan.md +0 -0
  131. data/docs/scheduled_export.md +15 -0
  132. data/docs/scim_log.md +13 -0
  133. data/docs/session.md +232 -1
  134. data/docs/session_available_site.md +26 -0
  135. data/docs/setting.md +33 -0
  136. data/docs/settings.md +498 -0
  137. data/docs/settings_change.md +16 -0
  138. data/docs/sftp_action_log.md +21 -1
  139. data/docs/sftp_host_key.md +9 -0
  140. data/docs/share_group.md +15 -0
  141. data/docs/siem_http_destination.md +9 -0
  142. data/docs/siem_http_destination_event.md +18 -0
  143. data/docs/site.md +179 -0
  144. data/docs/site_subdomain_redirect.md +13 -0
  145. data/docs/snapshot.md +9 -0
  146. data/docs/ssl_certificate.md +37 -0
  147. data/docs/sso_event.md +19 -0
  148. data/docs/sso_strategy.md +406 -0
  149. data/docs/staging_site.md +591 -0
  150. data/docs/support_request.md +126 -0
  151. data/docs/sync.md +14 -0
  152. data/docs/sync_api_usage_snapshot.md +23 -0
  153. data/docs/sync_api_usage_snapshot_report.md +71 -0
  154. data/docs/sync_bandwidth_snapshot.md +48 -0
  155. data/docs/sync_log.md +20 -1
  156. data/docs/sync_run.md +21 -0
  157. data/docs/two_factor_authentication_method.md +169 -0
  158. data/docs/usage_daily_snapshot.md +18 -0
  159. data/docs/usage_snapshot.md +9 -0
  160. data/docs/user.md +49 -2
  161. data/docs/user_cipher_use.md +21 -0
  162. data/docs/user_lifecycle_rule.md +14 -0
  163. data/docs/user_request.md +9 -0
  164. data/docs/user_security_event.md +18 -0
  165. data/docs/user_sftp_client_use.md +15 -0
  166. data/docs/warning.md +36 -0
  167. data/docs/web_dav_action_log.md +21 -1
  168. data/docs/webauthn_sign_request.md +13 -0
  169. data/docs/workspace.md +15 -0
  170. data/docs/zip_download.md +32 -0
  171. data/docs/zip_download_file.md +45 -0
  172. data/docs/zip_download_files.md +23 -0
  173. data/lib/files.com/models/account.rb +346 -0
  174. data/lib/files.com/models/action_log.rb +24 -0
  175. data/lib/files.com/models/action_notification_export_result.rb +12 -0
  176. data/lib/files.com/models/action_webhook_failure.rb +34 -0
  177. data/lib/files.com/models/agent_proxy_identity.rb +47 -0
  178. data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
  179. data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
  180. data/lib/files.com/models/agent_v2_auth.rb +32 -0
  181. data/lib/files.com/models/ai_assistant_personality.rb +11 -0
  182. data/lib/files.com/models/ai_task.rb +11 -0
  183. data/lib/files.com/models/announcement.rb +89 -0
  184. data/lib/files.com/models/api_key.rb +39 -5
  185. data/lib/files.com/models/api_request_log.rb +24 -0
  186. data/lib/files.com/models/app.rb +13 -0
  187. data/lib/files.com/models/as2_incoming_message.rb +19 -0
  188. data/lib/files.com/models/as2_outgoing_message.rb +19 -0
  189. data/lib/files.com/models/as2_partner.rb +11 -0
  190. data/lib/files.com/models/as2_station.rb +11 -0
  191. data/lib/files.com/models/automation.rb +30 -0
  192. data/lib/files.com/models/automation_log.rb +24 -0
  193. data/lib/files.com/models/automation_run.rb +16 -0
  194. data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
  195. data/lib/files.com/models/behavior.rb +11 -0
  196. data/lib/files.com/models/blog_post.rb +84 -0
  197. data/lib/files.com/models/bundle.rb +52 -0
  198. data/lib/files.com/models/bundle_action.rb +25 -0
  199. data/lib/files.com/models/bundle_download.rb +23 -0
  200. data/lib/files.com/models/bundle_notification.rb +15 -0
  201. data/lib/files.com/models/bundle_recipient.rb +27 -0
  202. data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
  203. data/lib/files.com/models/bundle_registration.rb +125 -0
  204. data/lib/files.com/models/certificate.rb +455 -0
  205. data/lib/files.com/models/chat_session.rb +11 -0
  206. data/lib/files.com/models/child_site.rb +1756 -0
  207. data/lib/files.com/models/child_site_management_policy.rb +5 -0
  208. data/lib/files.com/models/clickwrap.rb +9 -0
  209. data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
  210. data/lib/files.com/models/client_log.rb +25 -0
  211. data/lib/files.com/models/crash_report.rb +151 -0
  212. data/lib/files.com/models/custom_domain.rb +9 -0
  213. data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
  214. data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
  215. data/lib/files.com/models/dns_record.rb +5 -0
  216. data/lib/files.com/models/email_incoming_message.rb +21 -0
  217. data/lib/files.com/models/email_log.rb +22 -0
  218. data/lib/files.com/models/email_preference.rb +124 -0
  219. data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
  220. data/lib/files.com/models/email_preference_notification.rb +32 -0
  221. data/lib/files.com/models/event_channel.rb +11 -0
  222. data/lib/files.com/models/event_delivery_attempt.rb +11 -0
  223. data/lib/files.com/models/event_record.rb +21 -0
  224. data/lib/files.com/models/event_subscription.rb +11 -0
  225. data/lib/files.com/models/event_target.rb +11 -0
  226. data/lib/files.com/models/exavault_api_request_log.rb +24 -0
  227. data/lib/files.com/models/expectation.rb +11 -0
  228. data/lib/files.com/models/expectation_evaluation.rb +11 -0
  229. data/lib/files.com/models/expectation_incident.rb +11 -0
  230. data/lib/files.com/models/export.rb +153 -0
  231. data/lib/files.com/models/external_event.rb +19 -0
  232. data/lib/files.com/models/file.rb +207 -0
  233. data/lib/files.com/models/file_migration.rb +27 -0
  234. data/lib/files.com/models/file_migration_log.rb +22 -0
  235. data/lib/files.com/models/file_upload_part.rb +5 -0
  236. data/lib/files.com/models/folder.rb +69 -0
  237. data/lib/files.com/models/form_field_set.rb +9 -0
  238. data/lib/files.com/models/front_end_server.rb +335 -0
  239. data/lib/files.com/models/frontend_metric.rb +65 -0
  240. data/lib/files.com/models/ftp_action_log.rb +24 -0
  241. data/lib/files.com/models/gpg_key.rb +21 -0
  242. data/lib/files.com/models/group.rb +16 -0
  243. data/lib/files.com/models/group_user.rb +21 -1
  244. data/lib/files.com/models/history.rb +94 -0
  245. data/lib/files.com/models/history_export_result.rb +12 -0
  246. data/lib/files.com/models/holiday_region.rb +5 -0
  247. data/lib/files.com/models/inbound_s3_log.rb +24 -0
  248. data/lib/files.com/models/inbox.rb +123 -0
  249. data/lib/files.com/models/inbox_recipient.rb +25 -0
  250. data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
  251. data/lib/files.com/models/inbox_registration.rb +121 -0
  252. data/lib/files.com/models/inbox_upload.rb +19 -0
  253. data/lib/files.com/models/invoice.rb +5 -0
  254. data/lib/files.com/models/ip.rb +82 -0
  255. data/lib/files.com/models/ip_abuse_entry.rb +96 -0
  256. data/lib/files.com/models/ip_address.rb +37 -0
  257. data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
  258. data/lib/files.com/models/label.rb +22 -0
  259. data/lib/files.com/models/lead.rb +434 -0
  260. data/lib/files.com/models/lock.rb +27 -0
  261. data/lib/files.com/models/message.rb +12 -0
  262. data/lib/files.com/models/message_comment.rb +14 -0
  263. data/lib/files.com/models/message_comment_reaction.rb +14 -0
  264. data/lib/files.com/models/message_reaction.rb +12 -0
  265. data/lib/files.com/models/metadata_category.rb +9 -0
  266. data/lib/files.com/models/monitoring_stat.rb +43 -0
  267. data/lib/files.com/models/monitoring_stats.rb +22 -0
  268. data/lib/files.com/models/mover_package.rb +80 -0
  269. data/lib/files.com/models/notification.rb +18 -0
  270. data/lib/files.com/models/nps_response.rb +128 -0
  271. data/lib/files.com/models/oauth_redirect.rb +17 -0
  272. data/lib/files.com/models/outbound_connection_log.rb +24 -0
  273. data/lib/files.com/models/paired_api_key.rb +37 -0
  274. data/lib/files.com/models/partner.rb +11 -0
  275. data/lib/files.com/models/partner_channel.rb +11 -0
  276. data/lib/files.com/models/partner_site_request.rb +11 -0
  277. data/lib/files.com/models/payment.rb +5 -0
  278. data/lib/files.com/models/paypal_express_info.rb +67 -0
  279. data/lib/files.com/models/paypal_express_url.rb +17 -0
  280. data/lib/files.com/models/pending_work_event.rb +19 -0
  281. data/lib/files.com/models/permission.rb +22 -0
  282. data/lib/files.com/models/plan.rb +209 -0
  283. data/lib/files.com/models/preview.rb +57 -0
  284. data/lib/files.com/models/project.rb +5 -0
  285. data/lib/files.com/models/public_hosting_request_log.rb +24 -0
  286. data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
  287. data/lib/files.com/models/public_inbox.rb +142 -0
  288. data/lib/files.com/models/public_key.rb +21 -0
  289. data/lib/files.com/models/public_url.rb +177 -0
  290. data/lib/files.com/models/regional_migration.rb +12 -0
  291. data/lib/files.com/models/release.rb +153 -0
  292. data/lib/files.com/models/release_package.rb +37 -0
  293. data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
  294. data/lib/files.com/models/remote_mount_backend.rb +9 -0
  295. data/lib/files.com/models/remote_server.rb +297 -0
  296. data/lib/files.com/models/remote_server_credential.rb +13 -0
  297. data/lib/files.com/models/request.rb +12 -0
  298. data/lib/files.com/models/restore.rb +11 -0
  299. data/lib/files.com/models/revision.rb +53 -0
  300. data/lib/files.com/models/safe_plan.rb +12 -0
  301. data/lib/files.com/models/scheduled_export.rb +13 -0
  302. data/lib/files.com/models/scim_log.rb +9 -0
  303. data/lib/files.com/models/session.rb +493 -0
  304. data/lib/files.com/models/session_available_site.rb +47 -0
  305. data/lib/files.com/models/setting.rb +36 -0
  306. data/lib/files.com/models/settings.rb +1072 -0
  307. data/lib/files.com/models/settings_change.rb +16 -0
  308. data/lib/files.com/models/sftp_action_log.rb +24 -0
  309. data/lib/files.com/models/sftp_host_key.rb +5 -0
  310. data/lib/files.com/models/share_group.rb +9 -0
  311. data/lib/files.com/models/siem_http_destination.rb +5 -0
  312. data/lib/files.com/models/siem_http_destination_event.rb +19 -0
  313. data/lib/files.com/models/site.rb +1021 -0
  314. data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
  315. data/lib/files.com/models/snapshot.rb +5 -0
  316. data/lib/files.com/models/ssl_certificate.rb +77 -0
  317. data/lib/files.com/models/sso_event.rb +21 -0
  318. data/lib/files.com/models/sso_strategy.rb +632 -0
  319. data/lib/files.com/models/staging_site.rb +1781 -0
  320. data/lib/files.com/models/support_request.rb +209 -0
  321. data/lib/files.com/models/sync.rb +11 -0
  322. data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
  323. data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
  324. data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
  325. data/lib/files.com/models/sync_log.rb +22 -0
  326. data/lib/files.com/models/sync_run.rb +21 -0
  327. data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
  328. data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
  329. data/lib/files.com/models/usage_snapshot.rb +5 -0
  330. data/lib/files.com/models/user.rb +59 -0
  331. data/lib/files.com/models/user_cipher_use.rb +21 -0
  332. data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
  333. data/lib/files.com/models/user_request.rb +5 -0
  334. data/lib/files.com/models/user_security_event.rb +19 -0
  335. data/lib/files.com/models/user_sftp_client_use.rb +9 -0
  336. data/lib/files.com/models/warning.rb +38 -0
  337. data/lib/files.com/models/web_dav_action_log.rb +24 -0
  338. data/lib/files.com/models/webauthn_sign_request.rb +17 -0
  339. data/lib/files.com/models/workspace.rb +13 -0
  340. data/lib/files.com/models/zip_download.rb +73 -0
  341. data/lib/files.com/models/zip_download_file.rb +111 -0
  342. data/lib/files.com/models/zip_download_files.rb +42 -0
  343. data/lib/files.com/version.rb +1 -1
  344. data/lib/files.com.rb +59 -0
  345. metadata +120 -2
@@ -0,0 +1,96 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class IpAbuseEntry
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # string
13
+ def ip
14
+ @attributes[:ip]
15
+ end
16
+
17
+ def ip=(value)
18
+ @attributes[:ip] = value
19
+ end
20
+
21
+ # string
22
+ def list
23
+ @attributes[:list]
24
+ end
25
+
26
+ def list=(value)
27
+ @attributes[:list] = value
28
+ end
29
+
30
+ # string
31
+ def hostname
32
+ @attributes[:hostname]
33
+ end
34
+
35
+ def hostname=(value)
36
+ @attributes[:hostname] = value
37
+ end
38
+
39
+ # string
40
+ def reason
41
+ @attributes[:reason]
42
+ end
43
+
44
+ def reason=(value)
45
+ @attributes[:reason] = value
46
+ end
47
+
48
+ def save
49
+ if @attributes[:id]
50
+ raise NotImplementedError.new("The IpAbuseEntry object doesn't support updates.")
51
+ else
52
+ new_obj = IpAbuseEntry.create(@attributes, @options)
53
+ end
54
+
55
+ @attributes = new_obj.attributes
56
+ true
57
+ end
58
+
59
+ # Parameters:
60
+ # 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.
61
+ # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
62
+ def self.list(params = {}, options = {})
63
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
64
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
65
+
66
+ Api.send_request("/ip_abuse_entries", :get, params, options)
67
+ nil
68
+ end
69
+
70
+ def self.all(params = {}, options = {})
71
+ list(params, options)
72
+ nil
73
+ end
74
+
75
+ # Parameters:
76
+ # ip (required) - string
77
+ # list - string
78
+ # hostname - string
79
+ # reason - string
80
+ def self.create(params = {}, options = {})
81
+ raise InvalidParameterError.new("Bad parameter: ip must be an String") if params[:ip] and !params[:ip].is_a?(String)
82
+ raise InvalidParameterError.new("Bad parameter: list must be an String") if params[:list] and !params[:list].is_a?(String)
83
+ raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
84
+ raise InvalidParameterError.new("Bad parameter: reason must be an String") if params[:reason] and !params[:reason].is_a?(String)
85
+ raise MissingParameterError.new("Parameter missing: ip") unless params[:ip]
86
+
87
+ Api.send_request("/ip_abuse_entries", :post, params, options)
88
+ nil
89
+ end
90
+
91
+ def self.create_export(params = {}, options = {})
92
+ response, options = Api.send_request("/ip_abuse_entries/create_export", :post, params, options)
93
+ Export.new(response.data, options)
94
+ end
95
+ end
96
+ end
@@ -45,6 +45,18 @@ module Files
45
45
  list(params, options)
46
46
  end
47
47
 
48
+ # Parameters:
49
+ # 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.
50
+ # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
51
+ def self.get_active(params = {}, options = {})
52
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
53
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
54
+
55
+ List.new(PublicIpAddress, params) do
56
+ Api.send_request("/ip_addresses/active", :get, params, options)
57
+ end
58
+ end
59
+
48
60
  # Parameters:
49
61
  # 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.
50
62
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
@@ -80,5 +92,30 @@ module Files
80
92
  Api.send_request("/ip_addresses/reserved", :get, params, options)
81
93
  end
82
94
  end
95
+
96
+ def self.active_create_export(params = {}, options = {})
97
+ response, options = Api.send_request("/ip_addresses/active/create_export", :post, params, options)
98
+ Export.new(response.data, options)
99
+ end
100
+
101
+ def self.smartfile_reserved_create_export(params = {}, options = {})
102
+ response, options = Api.send_request("/ip_addresses/smartfile-reserved/create_export", :post, params, options)
103
+ Export.new(response.data, options)
104
+ end
105
+
106
+ def self.exavault_reserved_create_export(params = {}, options = {})
107
+ response, options = Api.send_request("/ip_addresses/exavault-reserved/create_export", :post, params, options)
108
+ Export.new(response.data, options)
109
+ end
110
+
111
+ def self.reserved_create_export(params = {}, options = {})
112
+ response, options = Api.send_request("/ip_addresses/reserved/create_export", :post, params, options)
113
+ Export.new(response.data, options)
114
+ end
115
+
116
+ def self.create_export(params = {}, options = {})
117
+ response, options = Api.send_request("/ip_addresses/create_export", :post, params, options)
118
+ Export.new(response.data, options)
119
+ end
83
120
  end
84
121
  end
@@ -174,6 +174,17 @@ module Files
174
174
  KeyLifecycleRule.new(response.data, options)
175
175
  end
176
176
 
177
+ # Parameters:
178
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
179
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type` and `workspace_id`. Valid field combinations are `[ workspace_id, key_type ]`.
180
+ def self.create_export(params = {}, options = {})
181
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
182
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
183
+
184
+ response, options = Api.send_request("/key_lifecycle_rules/create_export", :post, params, options)
185
+ Export.new(response.data, options)
186
+ end
187
+
177
188
  # Parameters:
178
189
  # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to keys in all workspaces.
179
190
  # expiration_days - int64 - Number of days after creation before an SSH key expires. Applies only to SSH keys.
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class Label
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ def self.list(params = {}, options = {})
13
+ Api.send_request("/labels", :get, params, options)
14
+ nil
15
+ end
16
+
17
+ def self.all(params = {}, options = {})
18
+ list(params, options)
19
+ nil
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,434 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class Lead
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - Lead ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ def id=(value)
18
+ @attributes[:id] = value
19
+ end
20
+
21
+ # string - Lead Cookie Code
22
+ def code
23
+ @attributes[:code]
24
+ end
25
+
26
+ def code=(value)
27
+ @attributes[:code] = value
28
+ end
29
+
30
+ # string - Lead name
31
+ def name
32
+ @attributes[:name]
33
+ end
34
+
35
+ def name=(value)
36
+ @attributes[:name] = value
37
+ end
38
+
39
+ # string - Lead address
40
+ def address
41
+ @attributes[:address]
42
+ end
43
+
44
+ def address=(value)
45
+ @attributes[:address] = value
46
+ end
47
+
48
+ # string - Lead address 2
49
+ def address_2
50
+ @attributes[:address_2]
51
+ end
52
+
53
+ def address_2=(value)
54
+ @attributes[:address_2] = value
55
+ end
56
+
57
+ # string - Lead city
58
+ def city
59
+ @attributes[:city]
60
+ end
61
+
62
+ def city=(value)
63
+ @attributes[:city] = value
64
+ end
65
+
66
+ # string - Lead company name
67
+ def company_name
68
+ @attributes[:company_name]
69
+ end
70
+
71
+ def company_name=(value)
72
+ @attributes[:company_name] = value
73
+ end
74
+
75
+ # string - Contact name at the company
76
+ def contact_name
77
+ @attributes[:contact_name]
78
+ end
79
+
80
+ def contact_name=(value)
81
+ @attributes[:contact_name] = value
82
+ end
83
+
84
+ # string - Lead country
85
+ def country
86
+ @attributes[:country]
87
+ end
88
+
89
+ def country=(value)
90
+ @attributes[:country] = value
91
+ end
92
+
93
+ # string - Lead preferred currency
94
+ def currency
95
+ @attributes[:currency]
96
+ end
97
+
98
+ def currency=(value)
99
+ @attributes[:currency] = value
100
+ end
101
+
102
+ # string - Lead email address
103
+ def email
104
+ @attributes[:email]
105
+ end
106
+
107
+ def email=(value)
108
+ @attributes[:email] = value
109
+ end
110
+
111
+ # string - Lead preferred language
112
+ def language
113
+ @attributes[:language]
114
+ end
115
+
116
+ def language=(value)
117
+ @attributes[:language] = value
118
+ end
119
+
120
+ # string - Lead phone number
121
+ def phone_number
122
+ @attributes[:phone_number]
123
+ end
124
+
125
+ def phone_number=(value)
126
+ @attributes[:phone_number] = value
127
+ end
128
+
129
+ # string - Lead state
130
+ def state
131
+ @attributes[:state]
132
+ end
133
+
134
+ def state=(value)
135
+ @attributes[:state] = value
136
+ end
137
+
138
+ # string - Lead zipcode
139
+ def zip
140
+ @attributes[:zip]
141
+ end
142
+
143
+ def zip=(value)
144
+ @attributes[:zip] = value
145
+ end
146
+
147
+ # string - Quality score of the lead
148
+ def lead_level
149
+ @attributes[:lead_level]
150
+ end
151
+
152
+ def lead_level=(value)
153
+ @attributes[:lead_level] = value
154
+ end
155
+
156
+ # string - Signup page split test group
157
+ def signup_page_split_test_group
158
+ @attributes[:signup_page_split_test_group]
159
+ end
160
+
161
+ def signup_page_split_test_group=(value)
162
+ @attributes[:signup_page_split_test_group] = value
163
+ end
164
+
165
+ # string
166
+ def recaptcha_token
167
+ @attributes[:recaptcha_token]
168
+ end
169
+
170
+ def recaptcha_token=(value)
171
+ @attributes[:recaptcha_token] = value
172
+ end
173
+
174
+ # string - Signup form name
175
+ def form_name
176
+ @attributes[:form_name]
177
+ end
178
+
179
+ def form_name=(value)
180
+ @attributes[:form_name] = value
181
+ end
182
+
183
+ # string - Source of the lead
184
+ def lead_source
185
+ @attributes[:lead_source]
186
+ end
187
+
188
+ def lead_source=(value)
189
+ @attributes[:lead_source] = value
190
+ end
191
+
192
+ # string - Opportunity comment
193
+ def opportunity_comment
194
+ @attributes[:opportunity_comment]
195
+ end
196
+
197
+ def opportunity_comment=(value)
198
+ @attributes[:opportunity_comment] = value
199
+ end
200
+
201
+ # string - Type of opportunity to create
202
+ def opportunity_type
203
+ @attributes[:opportunity_type]
204
+ end
205
+
206
+ def opportunity_type=(value)
207
+ @attributes[:opportunity_type] = value
208
+ end
209
+
210
+ # string - Google Adwords Click ID
211
+ def gclid
212
+ @attributes[:gclid]
213
+ end
214
+
215
+ def gclid=(value)
216
+ @attributes[:gclid] = value
217
+ end
218
+
219
+ # string - Brand: `files`, `exavault` or `mover`
220
+ def original_brand
221
+ @attributes[:original_brand]
222
+ end
223
+
224
+ def original_brand=(value)
225
+ @attributes[:original_brand] = value
226
+ end
227
+
228
+ # string - Marketing tracking - campaign
229
+ def utm_campaign
230
+ @attributes[:utm_campaign]
231
+ end
232
+
233
+ def utm_campaign=(value)
234
+ @attributes[:utm_campaign] = value
235
+ end
236
+
237
+ # string - Marketing tracking - content
238
+ def utm_content
239
+ @attributes[:utm_content]
240
+ end
241
+
242
+ def utm_content=(value)
243
+ @attributes[:utm_content] = value
244
+ end
245
+
246
+ # string - Marketing tracking - domain
247
+ def utm_domain
248
+ @attributes[:utm_domain]
249
+ end
250
+
251
+ def utm_domain=(value)
252
+ @attributes[:utm_domain] = value
253
+ end
254
+
255
+ # string - Marketing tracking - medium
256
+ def utm_medium
257
+ @attributes[:utm_medium]
258
+ end
259
+
260
+ def utm_medium=(value)
261
+ @attributes[:utm_medium] = value
262
+ end
263
+
264
+ # string - Marketing tracking - source
265
+ def utm_source
266
+ @attributes[:utm_source]
267
+ end
268
+
269
+ def utm_source=(value)
270
+ @attributes[:utm_source] = value
271
+ end
272
+
273
+ # string - Marketing tracking - term
274
+ def utm_term
275
+ @attributes[:utm_term]
276
+ end
277
+
278
+ def utm_term=(value)
279
+ @attributes[:utm_term] = value
280
+ end
281
+
282
+ # string - Time zone, as returned by Javascript
283
+ def time_zone
284
+ @attributes[:time_zone]
285
+ end
286
+
287
+ def time_zone=(value)
288
+ @attributes[:time_zone] = value
289
+ end
290
+
291
+ # int64 - Time zone offset (integer from -12 to 12)
292
+ def time_zone_offset
293
+ @attributes[:time_zone_offset]
294
+ end
295
+
296
+ def time_zone_offset=(value)
297
+ @attributes[:time_zone_offset] = value
298
+ end
299
+
300
+ def save
301
+ if @attributes[:id]
302
+ raise NotImplementedError.new("The Lead object doesn't support updates.")
303
+ else
304
+ new_obj = Lead.create(@attributes, @options)
305
+ end
306
+
307
+ @attributes = new_obj.attributes
308
+ true
309
+ end
310
+
311
+ # Parameters:
312
+ # recaptcha_token - string
313
+ # name - string - Lead name
314
+ # address - string - Lead address
315
+ # address_2 - string - Lead address 2
316
+ # city - string - Lead city
317
+ # contact_name - string - Contact name at the company
318
+ # currency - string - Lead preferred currency
319
+ # email - string - Lead email address
320
+ # language - string - Lead preferred language
321
+ # phone_number - string - Lead phone number
322
+ # state - string - Lead state
323
+ # zip - string - Lead zipcode
324
+ # form_name - string - Signup form name
325
+ # lead_source - string - Source of the lead
326
+ # opportunity_comment - string - Opportunity comment
327
+ # opportunity_type - string - Type of opportunity to create
328
+ # gclid - string - Google Adwords Click ID
329
+ # original_brand - string - Brand: `files`, `exavault` or `mover`
330
+ # utm_campaign - string - Marketing tracking - campaign
331
+ # utm_content - string - Marketing tracking - content
332
+ # utm_domain - string - Marketing tracking - domain
333
+ # utm_medium - string - Marketing tracking - medium
334
+ # utm_source - string - Marketing tracking - source
335
+ # utm_term - string - Marketing tracking - term
336
+ # time_zone - string - Time zone, as returned by Javascript
337
+ # time_zone_offset - int64 - Time zone offset (integer from -12 to 12)
338
+ def self.create(params = {}, options = {})
339
+ raise InvalidParameterError.new("Bad parameter: recaptcha_token must be an String") if params[:recaptcha_token] and !params[:recaptcha_token].is_a?(String)
340
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
341
+ raise InvalidParameterError.new("Bad parameter: address must be an String") if params[:address] and !params[:address].is_a?(String)
342
+ raise InvalidParameterError.new("Bad parameter: address_2 must be an String") if params[:address_2] and !params[:address_2].is_a?(String)
343
+ raise InvalidParameterError.new("Bad parameter: city must be an String") if params[:city] and !params[:city].is_a?(String)
344
+ raise InvalidParameterError.new("Bad parameter: contact_name must be an String") if params[:contact_name] and !params[:contact_name].is_a?(String)
345
+ raise InvalidParameterError.new("Bad parameter: currency must be an String") if params[:currency] and !params[:currency].is_a?(String)
346
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
347
+ raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
348
+ raise InvalidParameterError.new("Bad parameter: phone_number must be an String") if params[:phone_number] and !params[:phone_number].is_a?(String)
349
+ raise InvalidParameterError.new("Bad parameter: state must be an String") if params[:state] and !params[:state].is_a?(String)
350
+ raise InvalidParameterError.new("Bad parameter: zip must be an String") if params[:zip] and !params[:zip].is_a?(String)
351
+ raise InvalidParameterError.new("Bad parameter: form_name must be an String") if params[:form_name] and !params[:form_name].is_a?(String)
352
+ raise InvalidParameterError.new("Bad parameter: lead_source must be an String") if params[:lead_source] and !params[:lead_source].is_a?(String)
353
+ raise InvalidParameterError.new("Bad parameter: opportunity_comment must be an String") if params[:opportunity_comment] and !params[:opportunity_comment].is_a?(String)
354
+ raise InvalidParameterError.new("Bad parameter: opportunity_type must be an String") if params[:opportunity_type] and !params[:opportunity_type].is_a?(String)
355
+ raise InvalidParameterError.new("Bad parameter: gclid must be an String") if params[:gclid] and !params[:gclid].is_a?(String)
356
+ raise InvalidParameterError.new("Bad parameter: original_brand must be an String") if params[:original_brand] and !params[:original_brand].is_a?(String)
357
+ raise InvalidParameterError.new("Bad parameter: utm_campaign must be an String") if params[:utm_campaign] and !params[:utm_campaign].is_a?(String)
358
+ raise InvalidParameterError.new("Bad parameter: utm_content must be an String") if params[:utm_content] and !params[:utm_content].is_a?(String)
359
+ raise InvalidParameterError.new("Bad parameter: utm_domain must be an String") if params[:utm_domain] and !params[:utm_domain].is_a?(String)
360
+ raise InvalidParameterError.new("Bad parameter: utm_medium must be an String") if params[:utm_medium] and !params[:utm_medium].is_a?(String)
361
+ raise InvalidParameterError.new("Bad parameter: utm_source must be an String") if params[:utm_source] and !params[:utm_source].is_a?(String)
362
+ raise InvalidParameterError.new("Bad parameter: utm_term must be an String") if params[:utm_term] and !params[:utm_term].is_a?(String)
363
+ raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
364
+ raise InvalidParameterError.new("Bad parameter: time_zone_offset must be an Integer") if params[:time_zone_offset] and !params[:time_zone_offset].is_a?(Integer)
365
+
366
+ response, options = Api.send_request("/leads", :post, params, options)
367
+ Lead.new(response.data, options)
368
+ end
369
+
370
+ # Parameters:
371
+ # code (required) - string - Lead lookup code.
372
+ # recaptcha_token - string
373
+ # name - string - Lead name
374
+ # address - string - Lead address
375
+ # address_2 - string - Lead address 2
376
+ # city - string - Lead city
377
+ # contact_name - string - Contact name at the company
378
+ # currency - string - Lead preferred currency
379
+ # email - string - Lead email address
380
+ # language - string - Lead preferred language
381
+ # phone_number - string - Lead phone number
382
+ # state - string - Lead state
383
+ # zip - string - Lead zipcode
384
+ # form_name - string - Signup form name
385
+ # lead_source - string - Source of the lead
386
+ # opportunity_comment - string - Opportunity comment
387
+ # opportunity_type - string - Type of opportunity to create
388
+ # gclid - string - Google Adwords Click ID
389
+ # original_brand - string - Brand: `files`, `exavault` or `mover`
390
+ # utm_campaign - string - Marketing tracking - campaign
391
+ # utm_content - string - Marketing tracking - content
392
+ # utm_domain - string - Marketing tracking - domain
393
+ # utm_medium - string - Marketing tracking - medium
394
+ # utm_source - string - Marketing tracking - source
395
+ # utm_term - string - Marketing tracking - term
396
+ # time_zone - string - Time zone, as returned by Javascript
397
+ # time_zone_offset - int64 - Time zone offset (integer from -12 to 12)
398
+ def self.update(code, params = {}, options = {})
399
+ params ||= {}
400
+ params[:code] = code
401
+ raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
402
+ raise InvalidParameterError.new("Bad parameter: recaptcha_token must be an String") if params[:recaptcha_token] and !params[:recaptcha_token].is_a?(String)
403
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
404
+ raise InvalidParameterError.new("Bad parameter: address must be an String") if params[:address] and !params[:address].is_a?(String)
405
+ raise InvalidParameterError.new("Bad parameter: address_2 must be an String") if params[:address_2] and !params[:address_2].is_a?(String)
406
+ raise InvalidParameterError.new("Bad parameter: city must be an String") if params[:city] and !params[:city].is_a?(String)
407
+ raise InvalidParameterError.new("Bad parameter: contact_name must be an String") if params[:contact_name] and !params[:contact_name].is_a?(String)
408
+ raise InvalidParameterError.new("Bad parameter: currency must be an String") if params[:currency] and !params[:currency].is_a?(String)
409
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
410
+ raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
411
+ raise InvalidParameterError.new("Bad parameter: phone_number must be an String") if params[:phone_number] and !params[:phone_number].is_a?(String)
412
+ raise InvalidParameterError.new("Bad parameter: state must be an String") if params[:state] and !params[:state].is_a?(String)
413
+ raise InvalidParameterError.new("Bad parameter: zip must be an String") if params[:zip] and !params[:zip].is_a?(String)
414
+ raise InvalidParameterError.new("Bad parameter: form_name must be an String") if params[:form_name] and !params[:form_name].is_a?(String)
415
+ raise InvalidParameterError.new("Bad parameter: lead_source must be an String") if params[:lead_source] and !params[:lead_source].is_a?(String)
416
+ raise InvalidParameterError.new("Bad parameter: opportunity_comment must be an String") if params[:opportunity_comment] and !params[:opportunity_comment].is_a?(String)
417
+ raise InvalidParameterError.new("Bad parameter: opportunity_type must be an String") if params[:opportunity_type] and !params[:opportunity_type].is_a?(String)
418
+ raise InvalidParameterError.new("Bad parameter: gclid must be an String") if params[:gclid] and !params[:gclid].is_a?(String)
419
+ raise InvalidParameterError.new("Bad parameter: original_brand must be an String") if params[:original_brand] and !params[:original_brand].is_a?(String)
420
+ raise InvalidParameterError.new("Bad parameter: utm_campaign must be an String") if params[:utm_campaign] and !params[:utm_campaign].is_a?(String)
421
+ raise InvalidParameterError.new("Bad parameter: utm_content must be an String") if params[:utm_content] and !params[:utm_content].is_a?(String)
422
+ raise InvalidParameterError.new("Bad parameter: utm_domain must be an String") if params[:utm_domain] and !params[:utm_domain].is_a?(String)
423
+ raise InvalidParameterError.new("Bad parameter: utm_medium must be an String") if params[:utm_medium] and !params[:utm_medium].is_a?(String)
424
+ raise InvalidParameterError.new("Bad parameter: utm_source must be an String") if params[:utm_source] and !params[:utm_source].is_a?(String)
425
+ raise InvalidParameterError.new("Bad parameter: utm_term must be an String") if params[:utm_term] and !params[:utm_term].is_a?(String)
426
+ raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
427
+ raise InvalidParameterError.new("Bad parameter: time_zone_offset must be an Integer") if params[:time_zone_offset] and !params[:time_zone_offset].is_a?(Integer)
428
+ raise MissingParameterError.new("Parameter missing: code") unless params[:code]
429
+
430
+ response, options = Api.send_request("/leads/#{params[:code]}", :patch, params, options)
431
+ Lead.new(response.data, options)
432
+ end
433
+ end
434
+ end