files.com 1.1.768 → 1.1.770

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 (138) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +47 -7
  4. data/_VERSION +1 -1
  5. data/docs/file.md +37 -0
  6. data/lib/files.com/api.rb +9 -4
  7. data/lib/files.com/api_client.rb +181 -55
  8. data/lib/files.com/list.rb +98 -66
  9. data/lib/files.com/models/action_log.rb +7 -2
  10. data/lib/files.com/models/action_notification_export.rb +13 -3
  11. data/lib/files.com/models/action_notification_export_result.rb +7 -2
  12. data/lib/files.com/models/ai_assistant_personality.rb +34 -8
  13. data/lib/files.com/models/ai_task.rb +39 -8
  14. data/lib/files.com/models/api_key.rb +49 -10
  15. data/lib/files.com/models/api_request_log.rb +7 -2
  16. data/lib/files.com/models/app.rb +7 -2
  17. data/lib/files.com/models/as2_incoming_message.rb +7 -2
  18. data/lib/files.com/models/as2_outgoing_message.rb +7 -2
  19. data/lib/files.com/models/as2_partner.rb +34 -8
  20. data/lib/files.com/models/as2_station.rb +34 -8
  21. data/lib/files.com/models/automation.rb +50 -10
  22. data/lib/files.com/models/automation_log.rb +7 -2
  23. data/lib/files.com/models/automation_run.rb +31 -6
  24. data/lib/files.com/models/bandwidth_snapshot.rb +7 -2
  25. data/lib/files.com/models/behavior.rb +46 -10
  26. data/lib/files.com/models/bundle.rb +39 -8
  27. data/lib/files.com/models/bundle_action.rb +7 -2
  28. data/lib/files.com/models/bundle_download.rb +7 -2
  29. data/lib/files.com/models/bundle_notification.rb +34 -8
  30. data/lib/files.com/models/bundle_recipient.rb +14 -4
  31. data/lib/files.com/models/bundle_registration.rb +7 -2
  32. data/lib/files.com/models/chat_session.rb +13 -3
  33. data/lib/files.com/models/child_site_management_policy.rb +34 -8
  34. data/lib/files.com/models/clickwrap.rb +34 -8
  35. data/lib/files.com/models/custom_domain.rb +40 -9
  36. data/lib/files.com/models/desktop_configuration_profile.rb +34 -8
  37. data/lib/files.com/models/dns_record.rb +7 -2
  38. data/lib/files.com/models/email_incoming_message.rb +7 -2
  39. data/lib/files.com/models/email_log.rb +7 -2
  40. data/lib/files.com/models/event_channel.rb +34 -8
  41. data/lib/files.com/models/event_delivery_attempt.rb +13 -3
  42. data/lib/files.com/models/event_record.rb +13 -3
  43. data/lib/files.com/models/event_subscription.rb +34 -8
  44. data/lib/files.com/models/event_target.rb +34 -8
  45. data/lib/files.com/models/exavault_api_request_log.rb +7 -2
  46. data/lib/files.com/models/expectation.rb +40 -9
  47. data/lib/files.com/models/expectation_evaluation.rb +13 -3
  48. data/lib/files.com/models/expectation_incident.rb +31 -6
  49. data/lib/files.com/models/external_event.rb +20 -5
  50. data/lib/files.com/models/file.rb +93 -15
  51. data/lib/files.com/models/file_comment.rb +28 -7
  52. data/lib/files.com/models/file_comment_reaction.rb +11 -2
  53. data/lib/files.com/models/file_migration.rb +6 -1
  54. data/lib/files.com/models/file_migration_log.rb +7 -2
  55. data/lib/files.com/models/folder.rb +13 -3
  56. data/lib/files.com/models/form_field_set.rb +34 -8
  57. data/lib/files.com/models/ftp_action_log.rb +7 -2
  58. data/lib/files.com/models/gpg_key.rb +34 -8
  59. data/lib/files.com/models/group.rb +34 -8
  60. data/lib/files.com/models/group_user.rb +29 -7
  61. data/lib/files.com/models/history.rb +35 -10
  62. data/lib/files.com/models/history_export.rb +13 -3
  63. data/lib/files.com/models/history_export_result.rb +7 -2
  64. data/lib/files.com/models/holiday_calendar.rb +34 -8
  65. data/lib/files.com/models/holiday_region.rb +7 -2
  66. data/lib/files.com/models/inbound_s3_log.rb +7 -2
  67. data/lib/files.com/models/inbox_recipient.rb +14 -4
  68. data/lib/files.com/models/inbox_registration.rb +7 -2
  69. data/lib/files.com/models/inbox_upload.rb +7 -2
  70. data/lib/files.com/models/integration_centric_profile.rb +34 -8
  71. data/lib/files.com/models/invoice.rb +13 -3
  72. data/lib/files.com/models/ip_address.rb +28 -8
  73. data/lib/files.com/models/key_lifecycle_rule.rb +34 -8
  74. data/lib/files.com/models/lock.rb +18 -3
  75. data/lib/files.com/models/metadata_category.rb +41 -10
  76. data/lib/files.com/models/notification.rb +34 -8
  77. data/lib/files.com/models/outbound_connection_log.rb +7 -2
  78. data/lib/files.com/models/partner.rb +34 -8
  79. data/lib/files.com/models/partner_channel.rb +34 -8
  80. data/lib/files.com/models/partner_channel_template.rb +34 -8
  81. data/lib/files.com/models/partner_site.rb +4 -0
  82. data/lib/files.com/models/partner_site_request.rb +33 -4
  83. data/lib/files.com/models/payment.rb +13 -3
  84. data/lib/files.com/models/pending_work_event.rb +13 -3
  85. data/lib/files.com/models/permission.rb +18 -4
  86. data/lib/files.com/models/public_hosting_request_log.rb +7 -2
  87. data/lib/files.com/models/public_key.rb +34 -8
  88. data/lib/files.com/models/remote_bandwidth_snapshot.rb +7 -2
  89. data/lib/files.com/models/remote_mount_backend.rb +39 -8
  90. data/lib/files.com/models/remote_server.rb +52 -11
  91. data/lib/files.com/models/remote_server_credential.rb +34 -8
  92. data/lib/files.com/models/request.rb +25 -6
  93. data/lib/files.com/models/restore.rb +14 -4
  94. data/lib/files.com/models/schedule.rb +34 -8
  95. data/lib/files.com/models/scheduled_export.rb +34 -8
  96. data/lib/files.com/models/scim_log.rb +13 -3
  97. data/lib/files.com/models/secret.rb +34 -8
  98. data/lib/files.com/models/session.rb +11 -2
  99. data/lib/files.com/models/settings_change.rb +7 -2
  100. data/lib/files.com/models/sftp_action_log.rb +7 -2
  101. data/lib/files.com/models/sftp_host_key.rb +34 -8
  102. data/lib/files.com/models/share_group.rb +34 -8
  103. data/lib/files.com/models/siem_http_destination.rb +39 -8
  104. data/lib/files.com/models/siem_http_destination_event.rb +13 -3
  105. data/lib/files.com/models/site.rb +16 -3
  106. data/lib/files.com/models/site_subdomain_redirect.rb +17 -3
  107. data/lib/files.com/models/snapshot.rb +39 -8
  108. data/lib/files.com/models/sso_event.rb +13 -3
  109. data/lib/files.com/models/sso_strategy.rb +18 -3
  110. data/lib/files.com/models/style.rb +20 -5
  111. data/lib/files.com/models/sync.rb +44 -8
  112. data/lib/files.com/models/sync_log.rb +7 -2
  113. data/lib/files.com/models/sync_run.rb +13 -3
  114. data/lib/files.com/models/usage_daily_snapshot.rb +7 -2
  115. data/lib/files.com/models/usage_snapshot.rb +7 -2
  116. data/lib/files.com/models/user.rb +50 -8
  117. data/lib/files.com/models/user_additional_email_recipient.rb +34 -8
  118. data/lib/files.com/models/user_cipher_use.rb +7 -2
  119. data/lib/files.com/models/user_lifecycle_rule.rb +34 -8
  120. data/lib/files.com/models/user_request.rb +24 -5
  121. data/lib/files.com/models/user_security_event.rb +13 -3
  122. data/lib/files.com/models/user_sftp_client_use.rb +7 -2
  123. data/lib/files.com/models/web_dav_action_log.rb +7 -2
  124. data/lib/files.com/models/webhook_test.rb +7 -2
  125. data/lib/files.com/models/workspace.rb +34 -8
  126. data/lib/files.com/response.rb +24 -0
  127. data/lib/files.com/sizable_io.rb +65 -4
  128. data/lib/files.com/version.rb +1 -1
  129. data/lib/files.com.rb +23 -1
  130. data/spec/language_spec.rb +20 -10
  131. data/spec/lib/api_client_spec.rb +173 -18
  132. data/spec/list_spec.rb +203 -187
  133. data/spec/models/file_transfer_spec.rb +346 -0
  134. data/spec/models/persistence_spec.rb +167 -0
  135. data/spec/spec_helper.rb +122 -6
  136. data/spec/support/stubbed_api.rb +14 -0
  137. data/spec/support/transfer_server.rb +60 -0
  138. metadata +6 -2
@@ -509,7 +509,9 @@ module Files
509
509
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
510
510
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
511
511
 
512
- Api.send_request("/automations/#{@attributes[:id]}", :patch, params, @options)
512
+ response, options = Api.send_request("/automations/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("Automation") }
513
+ @attributes = response.data
514
+ [ response, options ]
513
515
  end
514
516
 
515
517
  def delete(params = {})
@@ -529,12 +531,12 @@ module Files
529
531
 
530
532
  def save
531
533
  if @attributes[:id]
532
- new_obj = update(@attributes)
534
+ update(@attributes)
533
535
  else
534
536
  new_obj = Automation.create(@attributes, @options)
537
+ @attributes = new_obj.attributes
535
538
  end
536
539
 
537
- @attributes = new_obj.attributes
538
540
  true
539
541
  end
540
542
 
@@ -547,6 +549,11 @@ module Files
547
549
  # 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`.
548
550
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
549
551
  # 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`.
552
+ #
553
+ # params:: Hash of API operation parameter values.
554
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
555
+ #
556
+ # Returns a Files::List of Files::Automation objects.
550
557
  def self.list(params = {}, options = {})
551
558
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
552
559
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -557,8 +564,8 @@ module Files
557
564
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
558
565
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
559
566
 
560
- List.new(Automation, params) do
561
- Api.send_request("/automations", :get, params, options)
567
+ List.new(Automation, params) do |page_params, &check_page|
568
+ Api.send_request("/automations", :get, page_params, options, &check_page)
562
569
  end
563
570
  end
564
571
 
@@ -568,13 +575,18 @@ module Files
568
575
 
569
576
  # Parameters:
570
577
  # id (required) - int64 - Automation ID.
578
+ #
579
+ # params:: Hash of API operation parameter values.
580
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
581
+ #
582
+ # Returns a Files::Automation.
571
583
  def self.find(id, params = {}, options = {})
572
584
  params ||= {}
573
585
  params[:id] = id
574
586
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
575
587
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
576
588
 
577
- response, options = Api.send_request("/automations/#{params[:id]}", :get, params, options)
589
+ response, options = Api.send_request("/automations/#{params[:id]}", :get, params, options) { |reply| reply.require_object("Automation") }
578
590
  Automation.new(response.data, options)
579
591
  end
580
592
 
@@ -582,8 +594,12 @@ module Files
582
594
  find(id, params, options)
583
595
  end
584
596
 
597
+ # params:: Hash of API operation parameter values.
598
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
599
+ #
600
+ # Returns a Files::AutomationAuthoringSchema.
585
601
  def self.get_authoring_schema(params = {}, options = {})
586
- response, options = Api.send_request("/automations/authoring_schema", :get, params, options)
602
+ response, options = Api.send_request("/automations/authoring_schema", :get, params, options) { |reply| reply.require_object("AutomationAuthoringSchema") }
587
603
  AutomationAuthoringSchema.new(response.data, options)
588
604
  end
589
605
 
@@ -624,6 +640,11 @@ module Files
624
640
  # recurring_days - array(int64) - If trigger type is `daily`, this specifies one or more day numbers to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
625
641
  # automation (required) - string - Automation type
626
642
  # workspace_id - int64 - Workspace ID
643
+ #
644
+ # params:: Hash of API operation parameter values.
645
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
646
+ #
647
+ # Returns a Files::Automation.
627
648
  def self.create(params = {}, options = {})
628
649
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params[:source] and !params[:source].is_a?(String)
629
650
  raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params[:destinations] and !params[:destinations].is_a?(Array)
@@ -656,18 +677,23 @@ module Files
656
677
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
657
678
  raise MissingParameterError.new("Parameter missing: automation") unless params[:automation]
658
679
 
659
- response, options = Api.send_request("/automations", :post, params, options)
680
+ response, options = Api.send_request("/automations", :post, params, options) { |reply| reply.require_object("Automation") }
660
681
  Automation.new(response.data, options)
661
682
  end
662
683
 
663
684
  # Upgrade a legacy Automation to Automation v2
685
+ #
686
+ # params:: Hash of API operation parameter values.
687
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
688
+ #
689
+ # Returns a Files::Automation.
664
690
  def self.upgrade(id, params = {}, options = {})
665
691
  params ||= {}
666
692
  params[:id] = id
667
693
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
668
694
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
669
695
 
670
- response, options = Api.send_request("/automations/#{params[:id]}/upgrade", :post, params, options)
696
+ response, options = Api.send_request("/automations/#{params[:id]}/upgrade", :post, params, options) { |reply| reply.require_object("Automation") }
671
697
  Automation.new(response.data, options)
672
698
  end
673
699
 
@@ -675,6 +701,11 @@ module Files
675
701
  #
676
702
  # Parameters:
677
703
  # items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
704
+ #
705
+ # params:: Hash of API operation parameter values.
706
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
707
+ #
708
+ # Returns nil.
678
709
  def self.manual_run(id, params = {}, options = {})
679
710
  params ||= {}
680
711
  params[:id] = id
@@ -722,6 +753,11 @@ module Files
722
753
  # 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`.
723
754
  # recurring_days - array(int64) - If trigger type is `daily`, this specifies one or more day numbers to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
724
755
  # automation - string - Automation type
756
+ #
757
+ # params:: Hash of API operation parameter values.
758
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
759
+ #
760
+ # Returns a Files::Automation.
725
761
  def self.update(id, params = {}, options = {})
726
762
  params ||= {}
727
763
  params[:id] = id
@@ -756,10 +792,14 @@ module Files
756
792
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
757
793
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
758
794
 
759
- response, options = Api.send_request("/automations/#{params[:id]}", :patch, params, options)
795
+ response, options = Api.send_request("/automations/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("Automation") }
760
796
  Automation.new(response.data, options)
761
797
  end
762
798
 
799
+ # params:: Hash of API operation parameter values.
800
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
801
+ #
802
+ # Returns nil.
763
803
  def self.delete(id, params = {}, options = {})
764
804
  params ||= {}
765
805
  params[:id] = id