files.com 1.1.669 → 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 (347) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/_VERSION +1 -1
  4. data/docs/account.md +155 -0
  5. data/docs/action_log.md +21 -1
  6. data/docs/action_notification_export_result.md +17 -0
  7. data/docs/action_webhook_failure.md +28 -0
  8. data/docs/agent_proxy_identity.md +49 -0
  9. data/docs/agent_proxy_identity_endpoint.md +11 -0
  10. data/docs/agent_proxy_identity_result.md +24 -0
  11. data/docs/agent_v2_auth.md +17 -0
  12. data/docs/ai_assistant_personality.md +14 -0
  13. data/docs/ai_task.md +14 -0
  14. data/docs/announcement.md +57 -0
  15. data/docs/api_key.md +27 -1
  16. data/docs/api_request_log.md +21 -1
  17. data/docs/app.md +15 -0
  18. data/docs/as2_incoming_message.md +18 -0
  19. data/docs/as2_outgoing_message.md +18 -0
  20. data/docs/as2_partner.md +14 -0
  21. data/docs/as2_station.md +14 -0
  22. data/docs/automation.md +22 -1
  23. data/docs/automation_log.md +21 -1
  24. data/docs/automation_run.md +19 -0
  25. data/docs/bandwidth_snapshot.md +18 -0
  26. data/docs/behavior.md +14 -0
  27. data/docs/blog_post.md +57 -0
  28. data/docs/bundle.md +50 -1
  29. data/docs/bundle_action.md +25 -0
  30. data/docs/bundle_download.md +23 -0
  31. data/docs/bundle_notification.md +19 -0
  32. data/docs/bundle_recipient.md +21 -0
  33. data/docs/bundle_recipient_registration.md +39 -0
  34. data/docs/bundle_registration.md +61 -0
  35. data/docs/certificate.md +258 -0
  36. data/docs/chat_session.md +14 -0
  37. data/docs/child_site.md +583 -0
  38. data/docs/child_site_management_policy.md +9 -0
  39. data/docs/clickwrap.md +13 -0
  40. data/docs/clickwrap_acceptance.md +30 -0
  41. data/docs/client_log.md +17 -0
  42. data/docs/crash_report.md +50 -0
  43. data/docs/custom_domain.md +13 -0
  44. data/docs/custom_domain_for_proxy.md +23 -0
  45. data/docs/desktop_configuration_profile.md +14 -0
  46. data/docs/dns_record.md +9 -0
  47. data/docs/email_incoming_message.md +19 -0
  48. data/docs/email_log.md +20 -1
  49. data/docs/email_preference.md +108 -0
  50. data/docs/email_preference_bundle_notification.md +15 -0
  51. data/docs/email_preference_notification.md +17 -0
  52. data/docs/event_channel.md +14 -0
  53. data/docs/event_delivery_attempt.md +14 -0
  54. data/docs/event_record.md +19 -0
  55. data/docs/event_subscription.md +14 -0
  56. data/docs/event_target.md +14 -0
  57. data/docs/exavault_api_request_log.md +21 -1
  58. data/docs/expectation.md +14 -0
  59. data/docs/expectation_evaluation.md +14 -0
  60. data/docs/expectation_incident.md +14 -0
  61. data/docs/export.md +90 -0
  62. data/docs/external_event.md +18 -0
  63. data/docs/file.md +90 -2
  64. data/docs/file_migration.md +32 -0
  65. data/docs/file_migration_log.md +20 -1
  66. data/docs/file_upload_part.md +3 -1
  67. data/docs/folder.md +20 -0
  68. data/docs/form_field_set.md +15 -0
  69. data/docs/front_end_server.md +111 -0
  70. data/docs/frontend_metric.md +34 -0
  71. data/docs/ftp_action_log.md +21 -1
  72. data/docs/gpg_key.md +21 -0
  73. data/docs/group.md +19 -0
  74. data/docs/group_user.md +22 -2
  75. data/docs/history.md +85 -0
  76. data/docs/history_export_result.md +17 -0
  77. data/docs/holiday_region.md +9 -0
  78. data/docs/inbound_s3_log.md +21 -1
  79. data/docs/inbox.md +102 -0
  80. data/docs/inbox_recipient.md +19 -0
  81. data/docs/inbox_recipient_registration.md +35 -0
  82. data/docs/inbox_registration.md +57 -0
  83. data/docs/inbox_upload.md +18 -0
  84. data/docs/invoice.md +9 -0
  85. data/docs/ip.md +63 -0
  86. data/docs/ip_abuse_entry.md +47 -0
  87. data/docs/ip_address.md +59 -0
  88. data/docs/key_lifecycle_rule.md +14 -0
  89. data/docs/label.md +9 -0
  90. data/docs/lead.md +161 -0
  91. data/docs/lock.md +15 -0
  92. data/docs/message.md +17 -0
  93. data/docs/message_comment.md +18 -0
  94. data/docs/message_comment_reaction.md +18 -0
  95. data/docs/message_reaction.md +17 -0
  96. data/docs/metadata_category.md +13 -0
  97. data/docs/monitoring_stat.md +38 -0
  98. data/docs/monitoring_stats.md +15 -0
  99. data/docs/mover_package.md +68 -0
  100. data/docs/notification.md +20 -0
  101. data/docs/nps_response.md +75 -0
  102. data/docs/oauth_redirect.md +11 -0
  103. data/docs/outbound_connection_log.md +21 -1
  104. data/docs/paired_api_key.md +19 -0
  105. data/docs/partner.md +14 -0
  106. data/docs/partner_channel.md +14 -0
  107. data/docs/partner_site_request.md +14 -0
  108. data/docs/payment.md +9 -0
  109. data/docs/paypal_express_info.md +31 -0
  110. data/docs/paypal_express_url.md +11 -0
  111. data/docs/pending_work_event.md +18 -0
  112. data/docs/permission.md +22 -0
  113. data/docs/plan.md +107 -0
  114. data/docs/preview.md +57 -0
  115. data/docs/project.md +9 -0
  116. data/docs/public_hosting_request_log.md +21 -1
  117. data/docs/public_hosting_session_pairing.md +15 -0
  118. data/docs/public_inbox.md +121 -0
  119. data/docs/public_key.md +21 -0
  120. data/docs/public_url.md +59 -0
  121. data/docs/regional_migration.md +0 -0
  122. data/docs/release.md +83 -0
  123. data/docs/release_package.md +19 -0
  124. data/docs/remote_bandwidth_snapshot.md +18 -0
  125. data/docs/remote_mount_backend.md +13 -0
  126. data/docs/remote_server.md +233 -0
  127. data/docs/remote_server_credential.md +15 -0
  128. data/docs/request.md +17 -0
  129. data/docs/restore.md +14 -0
  130. data/docs/revision.md +40 -0
  131. data/docs/safe_plan.md +0 -0
  132. data/docs/scheduled_export.md +15 -0
  133. data/docs/scim_log.md +13 -0
  134. data/docs/session.md +232 -1
  135. data/docs/session_available_site.md +26 -0
  136. data/docs/setting.md +33 -0
  137. data/docs/settings.md +498 -0
  138. data/docs/settings_change.md +16 -0
  139. data/docs/sftp_action_log.md +21 -1
  140. data/docs/sftp_host_key.md +9 -0
  141. data/docs/share_group.md +15 -0
  142. data/docs/siem_http_destination.md +9 -0
  143. data/docs/siem_http_destination_event.md +18 -0
  144. data/docs/site.md +179 -0
  145. data/docs/site_subdomain_redirect.md +13 -0
  146. data/docs/snapshot.md +9 -0
  147. data/docs/ssl_certificate.md +37 -0
  148. data/docs/sso_event.md +19 -0
  149. data/docs/sso_strategy.md +406 -0
  150. data/docs/staging_site.md +591 -0
  151. data/docs/support_request.md +126 -0
  152. data/docs/sync.md +14 -0
  153. data/docs/sync_api_usage_snapshot.md +23 -0
  154. data/docs/sync_api_usage_snapshot_report.md +71 -0
  155. data/docs/sync_bandwidth_snapshot.md +48 -0
  156. data/docs/sync_log.md +20 -1
  157. data/docs/sync_run.md +21 -0
  158. data/docs/two_factor_authentication_method.md +169 -0
  159. data/docs/usage_daily_snapshot.md +18 -0
  160. data/docs/usage_snapshot.md +9 -0
  161. data/docs/user.md +49 -2
  162. data/docs/user_cipher_use.md +21 -0
  163. data/docs/user_lifecycle_rule.md +14 -0
  164. data/docs/user_request.md +9 -0
  165. data/docs/user_security_event.md +18 -0
  166. data/docs/user_sftp_client_use.md +15 -0
  167. data/docs/warning.md +36 -0
  168. data/docs/web_dav_action_log.md +21 -1
  169. data/docs/webauthn_sign_request.md +13 -0
  170. data/docs/workspace.md +15 -0
  171. data/docs/zip_download.md +32 -0
  172. data/docs/zip_download_file.md +45 -0
  173. data/docs/zip_download_files.md +23 -0
  174. data/lib/files.com/errors.rb +1 -0
  175. data/lib/files.com/models/account.rb +346 -0
  176. data/lib/files.com/models/action_log.rb +24 -0
  177. data/lib/files.com/models/action_notification_export_result.rb +12 -0
  178. data/lib/files.com/models/action_webhook_failure.rb +34 -0
  179. data/lib/files.com/models/agent_proxy_identity.rb +47 -0
  180. data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
  181. data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
  182. data/lib/files.com/models/agent_v2_auth.rb +32 -0
  183. data/lib/files.com/models/ai_assistant_personality.rb +11 -0
  184. data/lib/files.com/models/ai_task.rb +11 -0
  185. data/lib/files.com/models/announcement.rb +89 -0
  186. data/lib/files.com/models/api_key.rb +39 -5
  187. data/lib/files.com/models/api_request_log.rb +24 -0
  188. data/lib/files.com/models/app.rb +13 -0
  189. data/lib/files.com/models/as2_incoming_message.rb +19 -0
  190. data/lib/files.com/models/as2_outgoing_message.rb +19 -0
  191. data/lib/files.com/models/as2_partner.rb +11 -0
  192. data/lib/files.com/models/as2_station.rb +11 -0
  193. data/lib/files.com/models/automation.rb +30 -0
  194. data/lib/files.com/models/automation_log.rb +24 -0
  195. data/lib/files.com/models/automation_run.rb +16 -0
  196. data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
  197. data/lib/files.com/models/behavior.rb +11 -0
  198. data/lib/files.com/models/blog_post.rb +84 -0
  199. data/lib/files.com/models/bundle.rb +52 -0
  200. data/lib/files.com/models/bundle_action.rb +25 -0
  201. data/lib/files.com/models/bundle_download.rb +23 -0
  202. data/lib/files.com/models/bundle_notification.rb +15 -0
  203. data/lib/files.com/models/bundle_recipient.rb +27 -0
  204. data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
  205. data/lib/files.com/models/bundle_registration.rb +125 -0
  206. data/lib/files.com/models/certificate.rb +455 -0
  207. data/lib/files.com/models/chat_session.rb +11 -0
  208. data/lib/files.com/models/child_site.rb +1756 -0
  209. data/lib/files.com/models/child_site_management_policy.rb +5 -0
  210. data/lib/files.com/models/clickwrap.rb +9 -0
  211. data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
  212. data/lib/files.com/models/client_log.rb +25 -0
  213. data/lib/files.com/models/crash_report.rb +151 -0
  214. data/lib/files.com/models/custom_domain.rb +9 -0
  215. data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
  216. data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
  217. data/lib/files.com/models/dns_record.rb +5 -0
  218. data/lib/files.com/models/email_incoming_message.rb +21 -0
  219. data/lib/files.com/models/email_log.rb +22 -0
  220. data/lib/files.com/models/email_preference.rb +124 -0
  221. data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
  222. data/lib/files.com/models/email_preference_notification.rb +32 -0
  223. data/lib/files.com/models/event_channel.rb +11 -0
  224. data/lib/files.com/models/event_delivery_attempt.rb +11 -0
  225. data/lib/files.com/models/event_record.rb +21 -0
  226. data/lib/files.com/models/event_subscription.rb +11 -0
  227. data/lib/files.com/models/event_target.rb +11 -0
  228. data/lib/files.com/models/exavault_api_request_log.rb +24 -0
  229. data/lib/files.com/models/expectation.rb +11 -0
  230. data/lib/files.com/models/expectation_evaluation.rb +11 -0
  231. data/lib/files.com/models/expectation_incident.rb +11 -0
  232. data/lib/files.com/models/export.rb +153 -0
  233. data/lib/files.com/models/external_event.rb +19 -0
  234. data/lib/files.com/models/file.rb +207 -0
  235. data/lib/files.com/models/file_migration.rb +27 -0
  236. data/lib/files.com/models/file_migration_log.rb +22 -0
  237. data/lib/files.com/models/file_upload_part.rb +5 -0
  238. data/lib/files.com/models/folder.rb +69 -0
  239. data/lib/files.com/models/form_field_set.rb +9 -0
  240. data/lib/files.com/models/front_end_server.rb +335 -0
  241. data/lib/files.com/models/frontend_metric.rb +65 -0
  242. data/lib/files.com/models/ftp_action_log.rb +24 -0
  243. data/lib/files.com/models/gpg_key.rb +21 -0
  244. data/lib/files.com/models/group.rb +16 -0
  245. data/lib/files.com/models/group_user.rb +21 -1
  246. data/lib/files.com/models/history.rb +94 -0
  247. data/lib/files.com/models/history_export_result.rb +12 -0
  248. data/lib/files.com/models/holiday_region.rb +5 -0
  249. data/lib/files.com/models/inbound_s3_log.rb +24 -0
  250. data/lib/files.com/models/inbox.rb +123 -0
  251. data/lib/files.com/models/inbox_recipient.rb +25 -0
  252. data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
  253. data/lib/files.com/models/inbox_registration.rb +121 -0
  254. data/lib/files.com/models/inbox_upload.rb +19 -0
  255. data/lib/files.com/models/invoice.rb +5 -0
  256. data/lib/files.com/models/ip.rb +82 -0
  257. data/lib/files.com/models/ip_abuse_entry.rb +96 -0
  258. data/lib/files.com/models/ip_address.rb +37 -0
  259. data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
  260. data/lib/files.com/models/label.rb +22 -0
  261. data/lib/files.com/models/lead.rb +434 -0
  262. data/lib/files.com/models/lock.rb +27 -0
  263. data/lib/files.com/models/message.rb +12 -0
  264. data/lib/files.com/models/message_comment.rb +14 -0
  265. data/lib/files.com/models/message_comment_reaction.rb +14 -0
  266. data/lib/files.com/models/message_reaction.rb +12 -0
  267. data/lib/files.com/models/metadata_category.rb +9 -0
  268. data/lib/files.com/models/monitoring_stat.rb +43 -0
  269. data/lib/files.com/models/monitoring_stats.rb +22 -0
  270. data/lib/files.com/models/mover_package.rb +80 -0
  271. data/lib/files.com/models/notification.rb +18 -0
  272. data/lib/files.com/models/nps_response.rb +128 -0
  273. data/lib/files.com/models/oauth_redirect.rb +17 -0
  274. data/lib/files.com/models/outbound_connection_log.rb +24 -0
  275. data/lib/files.com/models/paired_api_key.rb +37 -0
  276. data/lib/files.com/models/partner.rb +11 -0
  277. data/lib/files.com/models/partner_channel.rb +11 -0
  278. data/lib/files.com/models/partner_site_request.rb +11 -0
  279. data/lib/files.com/models/payment.rb +5 -0
  280. data/lib/files.com/models/paypal_express_info.rb +67 -0
  281. data/lib/files.com/models/paypal_express_url.rb +17 -0
  282. data/lib/files.com/models/pending_work_event.rb +19 -0
  283. data/lib/files.com/models/permission.rb +22 -0
  284. data/lib/files.com/models/plan.rb +209 -0
  285. data/lib/files.com/models/preview.rb +57 -0
  286. data/lib/files.com/models/project.rb +5 -0
  287. data/lib/files.com/models/public_hosting_request_log.rb +24 -0
  288. data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
  289. data/lib/files.com/models/public_inbox.rb +142 -0
  290. data/lib/files.com/models/public_key.rb +21 -0
  291. data/lib/files.com/models/public_url.rb +177 -0
  292. data/lib/files.com/models/regional_migration.rb +12 -0
  293. data/lib/files.com/models/release.rb +153 -0
  294. data/lib/files.com/models/release_package.rb +37 -0
  295. data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
  296. data/lib/files.com/models/remote_mount_backend.rb +9 -0
  297. data/lib/files.com/models/remote_server.rb +297 -0
  298. data/lib/files.com/models/remote_server_credential.rb +13 -0
  299. data/lib/files.com/models/request.rb +12 -0
  300. data/lib/files.com/models/restore.rb +11 -0
  301. data/lib/files.com/models/revision.rb +53 -0
  302. data/lib/files.com/models/safe_plan.rb +12 -0
  303. data/lib/files.com/models/scheduled_export.rb +13 -0
  304. data/lib/files.com/models/scim_log.rb +9 -0
  305. data/lib/files.com/models/session.rb +493 -0
  306. data/lib/files.com/models/session_available_site.rb +47 -0
  307. data/lib/files.com/models/setting.rb +36 -0
  308. data/lib/files.com/models/settings.rb +1072 -0
  309. data/lib/files.com/models/settings_change.rb +16 -0
  310. data/lib/files.com/models/sftp_action_log.rb +24 -0
  311. data/lib/files.com/models/sftp_host_key.rb +5 -0
  312. data/lib/files.com/models/share_group.rb +9 -0
  313. data/lib/files.com/models/siem_http_destination.rb +5 -0
  314. data/lib/files.com/models/siem_http_destination_event.rb +19 -0
  315. data/lib/files.com/models/site.rb +1021 -0
  316. data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
  317. data/lib/files.com/models/snapshot.rb +5 -0
  318. data/lib/files.com/models/ssl_certificate.rb +77 -0
  319. data/lib/files.com/models/sso_event.rb +21 -0
  320. data/lib/files.com/models/sso_strategy.rb +632 -0
  321. data/lib/files.com/models/staging_site.rb +1781 -0
  322. data/lib/files.com/models/support_request.rb +209 -0
  323. data/lib/files.com/models/sync.rb +11 -0
  324. data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
  325. data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
  326. data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
  327. data/lib/files.com/models/sync_log.rb +22 -0
  328. data/lib/files.com/models/sync_run.rb +21 -0
  329. data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
  330. data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
  331. data/lib/files.com/models/usage_snapshot.rb +5 -0
  332. data/lib/files.com/models/user.rb +59 -0
  333. data/lib/files.com/models/user_cipher_use.rb +21 -0
  334. data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
  335. data/lib/files.com/models/user_request.rb +5 -0
  336. data/lib/files.com/models/user_security_event.rb +19 -0
  337. data/lib/files.com/models/user_sftp_client_use.rb +9 -0
  338. data/lib/files.com/models/warning.rb +38 -0
  339. data/lib/files.com/models/web_dav_action_log.rb +24 -0
  340. data/lib/files.com/models/webauthn_sign_request.rb +17 -0
  341. data/lib/files.com/models/workspace.rb +13 -0
  342. data/lib/files.com/models/zip_download.rb +73 -0
  343. data/lib/files.com/models/zip_download_file.rb +111 -0
  344. data/lib/files.com/models/zip_download_files.rb +42 -0
  345. data/lib/files.com/version.rb +1 -1
  346. data/lib/files.com.rb +59 -0
  347. metadata +120 -2
@@ -378,6 +378,15 @@ module Files
378
378
  @attributes[:holiday_region] = value
379
379
  end
380
380
 
381
+ # int64 - Set to the ID of automation used as a clone template. This is an informational field only.
382
+ def cloned_from
383
+ @attributes[:cloned_from]
384
+ end
385
+
386
+ def cloned_from=(value)
387
+ @attributes[:cloned_from] = value
388
+ end
389
+
381
390
  # Manually Run Automation
382
391
  def manual_run(params = {})
383
392
  params ||= {}
@@ -563,6 +572,7 @@ module Files
563
572
  # recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
564
573
  # automation (required) - string - Automation type
565
574
  # workspace_id - int64 - Workspace ID
575
+ # cloned_from - int64 - Set to the ID of automation used as a clone template. This is an informational field only.
566
576
  def self.create(params = {}, options = {})
567
577
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params[:source] and !params[:source].is_a?(String)
568
578
  raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params[:destinations] and !params[:destinations].is_a?(Array)
@@ -591,6 +601,7 @@ module Files
591
601
  raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
592
602
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
593
603
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
604
+ raise InvalidParameterError.new("Bad parameter: cloned_from must be an Integer") if params[:cloned_from] and !params[:cloned_from].is_a?(Integer)
594
605
  raise MissingParameterError.new("Parameter missing: automation") unless params[:automation]
595
606
 
596
607
  response, options = Api.send_request("/automations", :post, params, options)
@@ -608,6 +619,25 @@ module Files
608
619
  nil
609
620
  end
610
621
 
622
+ # Parameters:
623
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `automation`, `last_modified_at` or `disabled`.
624
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at`, `workspace_id` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ workspace_id, disabled ]`, `[ disabled, automation ]`, `[ workspace_id, last_modified_at ]`, `[ automation, last_modified_at ]`, `[ workspace_id, automation ]`, `[ workspace_id, disabled, last_modified_at ]`, `[ disabled, automation, last_modified_at ]`, `[ workspace_id, disabled, automation ]`, `[ workspace_id, automation, last_modified_at ]` or `[ workspace_id, disabled, automation, last_modified_at ]`.
625
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
626
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
627
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
628
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
629
+ def self.create_export(params = {}, options = {})
630
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
631
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
632
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
633
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
634
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
635
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
636
+
637
+ response, options = Api.send_request("/automations/create_export", :post, params, options)
638
+ Export.new(response.data, options)
639
+ end
640
+
611
641
  # Parameters:
612
642
  # source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
613
643
  # destinations - array(string) - A list of destination paths. Use a trailing slash for folder destinations and omit it for file destinations.
@@ -59,6 +59,11 @@ module Files
59
59
  @attributes[:created_at]
60
60
  end
61
61
 
62
+ # string - Log Type
63
+ def log_type
64
+ @attributes[:log_type]
65
+ end
66
+
62
67
  # Parameters:
63
68
  # 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.
64
69
  # per_page - int64 - Number of records to show per page. (Max: 2000, 1,000 or less is recommended).
@@ -86,5 +91,24 @@ module Files
86
91
  def self.all(params = {}, options = {})
87
92
  list(params, options)
88
93
  end
94
+
95
+ # Parameters:
96
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation_id`, `automation_run_id`, `operation`, `path`, `status` or `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
97
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
98
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
99
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
100
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
101
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ created_at ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_id, created_at ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ automation_run_id, created_at ]`, `[ operation, path ]`, `[ operation, status ]`, `[ operation, created_at ]`, `[ path, status ]`, `[ path, created_at ]`, `[ status, created_at ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, automation_run_id, created_at ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, operation, created_at ]`, `[ automation_id, path, status ]`, `[ automation_id, path, created_at ]`, `[ automation_id, status, created_at ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, operation, created_at ]`, `[ automation_run_id, path, status ]`, `[ automation_run_id, path, created_at ]`, `[ automation_run_id, status, created_at ]`, `[ operation, path, status ]`, `[ operation, path, created_at ]`, `[ operation, status, created_at ]`, `[ path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, operation, created_at ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, automation_run_id, path, created_at ]`, `[ automation_id, automation_run_id, status, created_at ]`, `[ automation_id, operation, path, status ]`, `[ automation_id, operation, path, created_at ]`, `[ automation_id, operation, status, created_at ]`, `[ automation_id, path, status, created_at ]`, `[ automation_run_id, operation, path, status ]`, `[ automation_run_id, operation, path, created_at ]`, `[ automation_run_id, operation, status, created_at ]`, `[ automation_run_id, path, status, created_at ]`, `[ operation, path, status, created_at ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, created_at ]`, `[ automation_id, automation_run_id, operation, status, created_at ]`, `[ automation_id, automation_run_id, path, status, created_at ]`, `[ automation_id, operation, path, status, created_at ]`, `[ automation_run_id, operation, path, status, created_at ]` or `[ automation_id, automation_run_id, operation, path, status, created_at ]`.
102
+ def self.create_export(params = {}, options = {})
103
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
104
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
105
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
106
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
107
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
108
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
109
+
110
+ response, options = Api.send_request("/automation_logs/create_export", :post, params, options)
111
+ Export.new(response.data, options)
112
+ end
89
113
  end
90
114
  end
@@ -119,5 +119,21 @@ module Files
119
119
  def self.get(id, params = {}, options = {})
120
120
  find(id, params, options)
121
121
  end
122
+
123
+ # Parameters:
124
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
125
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
126
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
127
+ # automation_id (required) - int64 - ID of the associated Automation.
128
+ def self.create_export(params = {}, options = {})
129
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
130
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
131
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
132
+ raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params[:automation_id] and !params[:automation_id].is_a?(Integer)
133
+ raise MissingParameterError.new("Parameter missing: automation_id") unless params[:automation_id]
134
+
135
+ response, options = Api.send_request("/automation_runs/create_export", :post, params, options)
136
+ Export.new(response.data, options)
137
+ end
122
138
  end
123
139
  end
@@ -81,5 +81,24 @@ module Files
81
81
  def self.all(params = {}, options = {})
82
82
  list(params, options)
83
83
  end
84
+
85
+ # Parameters:
86
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `logged_at`.
87
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
88
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
89
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
90
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
91
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
92
+ def self.create_export(params = {}, options = {})
93
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
94
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
95
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
96
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
97
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
98
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
99
+
100
+ response, options = Api.send_request("/bandwidth_snapshots/create_export", :post, params, options)
101
+ Export.new(response.data, options)
102
+ end
84
103
  end
85
104
  end
@@ -254,6 +254,17 @@ module Files
254
254
  nil
255
255
  end
256
256
 
257
+ # Parameters:
258
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
259
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `clickwrap_id`, `form_field_set_id`, `impacts_ui`, `remote_server_id` or `behavior`. Valid field combinations are `[ impacts_ui, behavior ]`.
260
+ def self.create_export(params = {}, options = {})
261
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
262
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
263
+
264
+ response, options = Api.send_request("/behaviors/create_export", :post, params, options)
265
+ Export.new(response.data, options)
266
+ end
267
+
257
268
  # Parameters:
258
269
  # value - object - 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.
259
270
  # attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class BlogPost
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - Blog Post ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # string - Blog Post's Title
18
+ def title
19
+ @attributes[:title]
20
+ end
21
+
22
+ # string - Blog Post's Content
23
+ def content
24
+ @attributes[:content]
25
+ end
26
+
27
+ # date-time - Blog Post's Permanent Link
28
+ def link
29
+ @attributes[:link]
30
+ end
31
+
32
+ # date-time - Blog Post's Published Date
33
+ def published_at
34
+ @attributes[:published_at]
35
+ end
36
+
37
+ # Parameters:
38
+ # 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.
39
+ # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
40
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `published_at`.
41
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `published_at`.
42
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `published_at`.
43
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `published_at`.
44
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `published_at`.
45
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `published_at`.
46
+ def self.list(params = {}, options = {})
47
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
48
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
49
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
50
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
51
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
52
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
53
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
54
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
55
+
56
+ List.new(BlogPost, params) do
57
+ Api.send_request("/blog_posts", :get, params, options)
58
+ end
59
+ end
60
+
61
+ def self.all(params = {}, options = {})
62
+ list(params, options)
63
+ end
64
+
65
+ # Parameters:
66
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `published_at`.
67
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `published_at`.
68
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `published_at`.
69
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `published_at`.
70
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `published_at`.
71
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `published_at`.
72
+ def self.create_export(params = {}, options = {})
73
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
74
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
75
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
76
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
77
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
78
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
79
+
80
+ response, options = Api.send_request("/blog_posts/create_export", :post, params, options)
81
+ Export.new(response.data, options)
82
+ end
83
+ end
84
+ end
@@ -428,6 +428,15 @@ module Files
428
428
  @attributes[:bundlepaths] = value
429
429
  end
430
430
 
431
+ # int64 - Site id
432
+ def site_id
433
+ @attributes[:site_id]
434
+ end
435
+
436
+ def site_id=(value)
437
+ @attributes[:site_id] = value
438
+ end
439
+
431
440
  # string - Password for this bundle.
432
441
  def password
433
442
  @attributes[:password]
@@ -487,6 +496,7 @@ module Files
487
496
  # Parameters:
488
497
  # to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
489
498
  # note - string - Note to include in email.
499
+ # method - string - The method to use, must be email or null
490
500
  # recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
491
501
  def share(params = {})
492
502
  params ||= {}
@@ -495,6 +505,7 @@ module Files
495
505
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
496
506
  raise InvalidParameterError.new("Bad parameter: to must be an Array") if params[:to] and !params[:to].is_a?(Array)
497
507
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
508
+ raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
498
509
  raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params[:recipients] and !params[:recipients].is_a?(Array)
499
510
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
500
511
 
@@ -637,6 +648,21 @@ module Files
637
648
  find(id, params, options)
638
649
  end
639
650
 
651
+ # Parameters:
652
+ # code (required) - string - Bundle code
653
+ # imported_from_file_ac - boolean - Is bundle imported from File.ac?
654
+ # bundle_registration_code - string - Bundle registration cookie code
655
+ # recipient_code - string - Bundle recipient code
656
+ def self.get_info(params = {}, options = {})
657
+ raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
658
+ raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
659
+ raise InvalidParameterError.new("Bad parameter: recipient_code must be an String") if params[:recipient_code] and !params[:recipient_code].is_a?(String)
660
+ raise MissingParameterError.new("Parameter missing: code") unless params[:code]
661
+
662
+ response, options = Api.send_request("/bundles/info", :get, params, options)
663
+ Bundle.new(response.data, options)
664
+ end
665
+
640
666
  # Parameters:
641
667
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
642
668
  # paths (required) - array(string) - A list of paths to include in this bundle.
@@ -695,11 +721,36 @@ module Files
695
721
  Bundle.new(response.data, options)
696
722
  end
697
723
 
724
+ # Parameters:
725
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
726
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
727
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code`, `group_id`, `user_id` or `bypasses_site_expiration_rules`. Valid field combinations are `[ group_id, expires_at ]` and `[ user_id, expires_at ]`.
728
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
729
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
730
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
731
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at` and `expires_at`.
732
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
733
+ # deleted - boolean - If true, only list deleted Share Links.
734
+ def self.create_export(params = {}, options = {})
735
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
736
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
737
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
738
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
739
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
740
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
741
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
742
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
743
+
744
+ response, options = Api.send_request("/bundles/create_export", :post, params, options)
745
+ Export.new(response.data, options)
746
+ end
747
+
698
748
  # Send email(s) with a link to bundle
699
749
  #
700
750
  # Parameters:
701
751
  # to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
702
752
  # note - string - Note to include in email.
753
+ # method - string - The method to use, must be email or null
703
754
  # recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
704
755
  def self.share(id, params = {}, options = {})
705
756
  params ||= {}
@@ -707,6 +758,7 @@ module Files
707
758
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
708
759
  raise InvalidParameterError.new("Bad parameter: to must be an Array") if params[:to] and !params[:to].is_a?(Array)
709
760
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
761
+ raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
710
762
  raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params[:recipients] and !params[:recipients].is_a?(Array)
711
763
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
712
764
 
@@ -107,5 +107,30 @@ module Files
107
107
  def self.all(params = {}, options = {})
108
108
  list(params, options)
109
109
  end
110
+
111
+ # Parameters:
112
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
113
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `bundle_registration_id`.
114
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
115
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
116
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
117
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
118
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
119
+ # bundle_id - int64 - Bundle ID
120
+ # bundle_registration_id - int64 - Bundle Registration ID
121
+ def self.create_export(params = {}, options = {})
122
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
123
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
124
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
125
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
126
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
127
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
128
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
129
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
130
+ raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)
131
+
132
+ response, options = Api.send_request("/bundle_actions/create_export", :post, params, options)
133
+ Export.new(response.data, options)
134
+ end
110
135
  end
111
136
  end
@@ -65,5 +65,28 @@ module Files
65
65
  def self.all(params = {}, options = {})
66
66
  list(params, options)
67
67
  end
68
+
69
+ # Parameters:
70
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `created_at`.
71
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
72
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
73
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
74
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
75
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
76
+ # bundle_id - int64 - Bundle ID
77
+ # bundle_registration_id - int64 - BundleRegistration ID
78
+ def self.create_export(params = {}, options = {})
79
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
80
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
81
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
82
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
83
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
84
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
85
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
86
+ raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)
87
+
88
+ response, options = Api.send_request("/bundle_downloads/create_export", :post, params, options)
89
+ Export.new(response.data, options)
90
+ end
68
91
  end
69
92
  end
@@ -176,6 +176,21 @@ module Files
176
176
  BundleNotification.new(response.data, options)
177
177
  end
178
178
 
179
+ # Parameters:
180
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
181
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
182
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
183
+ # bundle_id - int64 - Bundle ID
184
+ def self.create_export(params = {}, options = {})
185
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
186
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
187
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
188
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
189
+
190
+ response, options = Api.send_request("/bundle_notifications/create_export", :post, params, options)
191
+ Export.new(response.data, options)
192
+ end
193
+
179
194
  # Parameters:
180
195
  # notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
181
196
  # notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
@@ -81,6 +81,15 @@ module Files
81
81
  @attributes[:bundle_id] = value
82
82
  end
83
83
 
84
+ # string - The method to use, must be email or null
85
+ def method
86
+ @attributes[:method]
87
+ end
88
+
89
+ def method=(value)
90
+ @attributes[:method] = value
91
+ end
92
+
84
93
  # boolean - Set to true to share the link with the recipient upon creation.
85
94
  def share_after_create
86
95
  @attributes[:share_after_create]
@@ -133,6 +142,7 @@ module Files
133
142
  # name - string - Name of recipient.
134
143
  # company - string - Company of recipient.
135
144
  # note - string - Note to include in email.
145
+ # method - string - The method to use, must be email or null
136
146
  # share_after_create - boolean - Set to true to share the link with the recipient upon creation.
137
147
  def self.create(params = {}, options = {})
138
148
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -141,11 +151,28 @@ module Files
141
151
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
142
152
  raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
143
153
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
154
+ raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
144
155
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
145
156
  raise MissingParameterError.new("Parameter missing: recipient") unless params[:recipient]
146
157
 
147
158
  response, options = Api.send_request("/bundle_recipients", :post, params, options)
148
159
  BundleRecipient.new(response.data, options)
149
160
  end
161
+
162
+ # Parameters:
163
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
164
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
165
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
166
+ # bundle_id (required) - int64 - List recipients for the bundle with this ID.
167
+ def self.create_export(params = {}, options = {})
168
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
169
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
170
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
171
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
172
+ raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
173
+
174
+ response, options = Api.send_request("/bundle_recipients/create_export", :post, params, options)
175
+ Export.new(response.data, options)
176
+ end
150
177
  end
151
178
  end
@@ -0,0 +1,105 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class BundleRecipientRegistration
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # string - The bundle recipient registration code. Use this to register for the bundle.
13
+ def code
14
+ @attributes[:code]
15
+ end
16
+
17
+ def code=(value)
18
+ @attributes[:code] = value
19
+ end
20
+
21
+ # string - If the recipient has already registered for this bundle, this is their registration code to get the bundle contents.
22
+ def bundle_registration_code
23
+ @attributes[:bundle_registration_code]
24
+ end
25
+
26
+ def bundle_registration_code=(value)
27
+ @attributes[:bundle_registration_code] = value
28
+ end
29
+
30
+ # string - The recipient's email address.
31
+ def recipient
32
+ @attributes[:recipient]
33
+ end
34
+
35
+ def recipient=(value)
36
+ @attributes[:recipient] = value
37
+ end
38
+
39
+ # string - The recipient's name.
40
+ def name
41
+ @attributes[:name]
42
+ end
43
+
44
+ def name=(value)
45
+ @attributes[:name] = value
46
+ end
47
+
48
+ # string - The recipient's company.
49
+ def company
50
+ @attributes[:company]
51
+ end
52
+
53
+ def company=(value)
54
+ @attributes[:company] = value
55
+ end
56
+
57
+ # boolean - Whether a one-time password was emailed to the recipient.
58
+ def password_emailed
59
+ @attributes[:password_emailed]
60
+ end
61
+
62
+ def password_emailed=(value)
63
+ @attributes[:password_emailed] = value
64
+ end
65
+
66
+ # string - InboxRegistration cookie code, if there is an associated InboxRegistration
67
+ def inbox_code
68
+ @attributes[:inbox_code]
69
+ end
70
+
71
+ def inbox_code=(value)
72
+ @attributes[:inbox_code] = value
73
+ end
74
+
75
+ # string - Bundle recipient code
76
+ def bundle_recipient_code
77
+ @attributes[:bundle_recipient_code]
78
+ end
79
+
80
+ def bundle_recipient_code=(value)
81
+ @attributes[:bundle_recipient_code] = value
82
+ end
83
+
84
+ def save
85
+ if @attributes[:id]
86
+ raise NotImplementedError.new("The BundleRecipientRegistration object doesn't support updates.")
87
+ else
88
+ new_obj = BundleRecipientRegistration.create(@attributes, @options)
89
+ end
90
+
91
+ @attributes = new_obj.attributes
92
+ true
93
+ end
94
+
95
+ # Parameters:
96
+ # bundle_recipient_code (required) - string - Bundle recipient code
97
+ def self.create(params = {}, options = {})
98
+ raise InvalidParameterError.new("Bad parameter: bundle_recipient_code must be an String") if params[:bundle_recipient_code] and !params[:bundle_recipient_code].is_a?(String)
99
+ raise MissingParameterError.new("Parameter missing: bundle_recipient_code") unless params[:bundle_recipient_code]
100
+
101
+ response, options = Api.send_request("/bundle_recipient_registrations", :post, params, options)
102
+ BundleRecipientRegistration.new(response.data, options)
103
+ end
104
+ end
105
+ end