comet_backup_ruby_sdk 2.7.0 → 2.9.0

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 (103) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/Gemfile.lock +1 -1
  4. data/comet_backup_ruby_sdk.gemspec +1 -1
  5. data/lib/comet/definitions.rb +331 -188
  6. data/lib/comet/models/add_bucket_response_message.rb +1 -0
  7. data/lib/comet/models/admin_resource_response.rb +1 -0
  8. data/lib/comet/models/azure_destination_location.rb +3 -0
  9. data/lib/comet/models/b2destination_location.rb +7 -0
  10. data/lib/comet/models/backup_job_advanced_options.rb +9 -0
  11. data/lib/comet/models/backup_job_detail.rb +15 -0
  12. data/lib/comet/models/backup_job_progress.rb +4 -0
  13. data/lib/comet/models/backup_rule_config.rb +17 -0
  14. data/lib/comet/models/backup_rule_event_triggers.rb +3 -0
  15. data/lib/comet/models/branding_options.rb +2 -0
  16. data/lib/comet/models/browse_disk_drives_response.rb +1 -0
  17. data/lib/comet/models/browse_edbresponse.rb +1 -0
  18. data/lib/comet/models/browse_hvresponse.rb +1 -0
  19. data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb +1 -0
  20. data/lib/comet/models/browse_office_365objects_response.rb +1 -0
  21. data/lib/comet/models/browse_sqlserver_response.rb +1 -0
  22. data/lib/comet/models/browse_vssresponse.rb +1 -0
  23. data/lib/comet/models/bucket_usage_info.rb +2 -0
  24. data/lib/comet/models/comet_apiresponse_message.rb +1 -0
  25. data/lib/comet/models/comet_destination_location.rb +1 -0
  26. data/lib/comet/models/constellation_check_report.rb +2 -0
  27. data/lib/comet/models/constellation_status_apiresponse.rb +1 -0
  28. data/lib/comet/models/content_measurement.rb +2 -0
  29. data/lib/comet/models/content_measurement_component.rb +12 -0
  30. data/lib/comet/models/create_group_policy_response.rb +1 -0
  31. data/lib/comet/models/default_email_report_policy.rb +4 -0
  32. data/lib/comet/models/destination_config.rb +47 -0
  33. data/lib/comet/models/destination_location.rb +36 -0
  34. data/lib/comet/models/destination_statistics.rb +2 -0
  35. data/lib/comet/models/device_config.rb +5 -0
  36. data/lib/comet/models/dispatcher_admin_sources_response.rb +1 -0
  37. data/lib/comet/models/dispatcher_stored_objects_response.rb +1 -0
  38. data/lib/comet/models/dispatcher_vault_snapshots_response.rb +1 -0
  39. data/lib/comet/models/dispatcher_windisk_snapshot_response.rb +1 -0
  40. data/lib/comet/models/email_options.rb +1 -0
  41. data/lib/comet/models/email_report_config.rb +3 -0
  42. data/lib/comet/models/email_report_generated_preview.rb +1 -0
  43. data/lib/comet/models/extra_file_exclusion.rb +4 -0
  44. data/lib/comet/models/file_option.rb +132 -0
  45. data/lib/comet/models/ftpdestination_location.rb +5 -0
  46. data/lib/comet/models/get_group_policy_response.rb +1 -0
  47. data/lib/comet/models/get_profile_and_hash_response_message.rb +4 -0
  48. data/lib/comet/models/get_profile_hash_response_message.rb +1 -0
  49. data/lib/comet/models/group_policy.rb +4 -0
  50. data/lib/comet/models/install_token_response.rb +1 -0
  51. data/lib/comet/models/job_entry.rb +2 -0
  52. data/lib/comet/models/live_user_connection.rb +11 -0
  53. data/lib/comet/models/local_destination_location.rb +5 -0
  54. data/lib/comet/models/mac_oscode_sign_properties.rb +1 -0
  55. data/lib/comet/models/mongo_dbconnection.rb +2 -0
  56. data/lib/comet/models/mssqllogin_args.rb +2 -0
  57. data/lib/comet/models/my_sqlconnection.rb +2 -0
  58. data/lib/comet/models/office_365custom_setting.rb +3 -0
  59. data/lib/comet/models/office_365custom_setting_v2.rb +9 -0
  60. data/lib/comet/models/office_365object_info.rb +1 -0
  61. data/lib/comet/models/organization.rb +85 -70
  62. data/lib/comet/models/request_storage_vault_response_message.rb +1 -0
  63. data/lib/comet/models/restore_job_advanced_options.rb +19 -0
  64. data/lib/comet/models/retention_policy.rb +1 -0
  65. data/lib/comet/models/retention_range.rb +1 -0
  66. data/lib/comet/models/s3destination_location.rb +1 -0
  67. data/lib/comet/models/search_result_file_info.rb +39 -17
  68. data/lib/comet/models/search_snapshots_response.rb +1 -0
  69. data/lib/comet/models/self_backup_export_options.rb +3 -0
  70. data/lib/comet/models/self_backup_target.rb +4 -0
  71. data/lib/comet/models/server_config_options.rb +28 -0
  72. data/lib/comet/models/server_meta_branding_properties.rb +4 -0
  73. data/lib/comet/models/server_meta_version_info.rb +8 -0
  74. data/lib/comet/models/session_key_regenerated_response.rb +1 -0
  75. data/lib/comet/models/session_options.rb +2 -0
  76. data/lib/comet/models/sftpdestination_location.rb +8 -0
  77. data/lib/comet/models/size_measurement.rb +3 -0
  78. data/lib/comet/models/source_basic_info.rb +1 -0
  79. data/lib/comet/models/source_config.rb +53 -0
  80. data/lib/comet/models/source_include_pattern.rb +5 -0
  81. data/lib/comet/models/spanned_destination_location.rb +11 -0
  82. data/lib/comet/models/sshconnection.rb +7 -0
  83. data/lib/comet/models/stored_object.rb +7 -0
  84. data/lib/comet/models/streamable_event.rb +42 -0
  85. data/lib/comet/models/swift_destination_location.rb +7 -0
  86. data/lib/comet/models/test_response.rb +1 -0
  87. data/lib/comet/models/time_span.rb +2 -0
  88. data/lib/comet/models/totp_regenerated_response.rb +1 -0
  89. data/lib/comet/models/u2fregistration_challenge_response.rb +1 -0
  90. data/lib/comet/models/uninstall_config.rb +4 -0
  91. data/lib/comet/models/update_campaign_options.rb +3 -0
  92. data/lib/comet/models/update_campaign_properties.rb +3 -0
  93. data/lib/comet/models/update_campaign_status.rb +3 -0
  94. data/lib/comet/models/user_on_server.rb +2 -0
  95. data/lib/comet/models/user_profile_config.rb +45 -0
  96. data/lib/comet/models/user_profile_fragment.rb +1 -0
  97. data/lib/comet/models/vmdksnapshot_view_options.rb +4 -0
  98. data/lib/comet/models/web_authn_registration_challenge_response.rb +1 -0
  99. data/lib/comet/models/web_interface_branding_properties.rb +2 -0
  100. data/lib/comet/models/webhook_option.rb +35 -16
  101. data/lib/comet/models/win_smbauth.rb +6 -0
  102. data/lib/comet_backup_ruby_sdk.rb +1 -0
  103. metadata +3 -2
@@ -10,17 +10,30 @@ require 'json'
10
10
  module Comet
11
11
 
12
12
  # WebhookOption is a typed class wrapper around the underlying Comet Server API data structure.
13
+ # WebhookOption defines the configuration of a webhook target. The Comet Server will send a live
14
+ # HTTP POST event to the webhook URL when certain events happen.
13
15
  class WebhookOption
14
16
 
17
+ # The target URL to POST the event data to
15
18
  # @type [String] url
16
19
  attr_accessor :url
17
20
 
18
- # @type [Array<Number>] white_listed_event_types
19
- attr_accessor :white_listed_event_types
20
-
21
+ # CustomHeaders allows specifying custom headers which are added to the outgoing POST request
22
+ # from Comet Server. Custom headers are specified as (header name, header value) pairs. If a
23
+ # custom header conflicts with a header required by HTTP or the Comet tracing ID header
24
+ # (`x-Comet-Tracing-Id`), it will be ignored.
21
25
  # @type [Hash{String => String}] custom_headers
22
26
  attr_accessor :custom_headers
23
27
 
28
+ # One of the STREAM_LEVEL_ constants. This controls how much data is sent in the webhook event.
29
+ # @type [String] level
30
+ attr_accessor :level
31
+
32
+ # Configure a subset of allowed event types (see SEVT_ constants). If the array is empty, all events
33
+ # will be sent
34
+ # @type [Array<Number>] white_listed_event_types
35
+ attr_accessor :white_listed_event_types
36
+
24
37
  # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
25
38
  attr_accessor :unknown_json_fields
26
39
 
@@ -30,8 +43,9 @@ module Comet
30
43
 
31
44
  def clear
32
45
  @url = ''
33
- @white_listed_event_types = []
34
46
  @custom_headers = {}
47
+ @level = ''
48
+ @white_listed_event_types = []
35
49
  @unknown_json_fields = {}
36
50
  end
37
51
 
@@ -52,17 +66,6 @@ module Comet
52
66
  raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
53
67
 
54
68
  @url = v
55
- when 'WhiteListedEventTypes'
56
- if v.nil?
57
- @white_listed_event_types = []
58
- else
59
- @white_listed_event_types = Array.new(v.length)
60
- v.each_with_index do |v1, i1|
61
- raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
62
-
63
- @white_listed_event_types[i1] = v1
64
- end
65
- end
66
69
  when 'CustomHeaders'
67
70
  @custom_headers = {}
68
71
  if v.nil?
@@ -74,6 +77,21 @@ module Comet
74
77
  @custom_headers[k1] = v1
75
78
  end
76
79
  end
80
+ when 'Level'
81
+ raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
82
+
83
+ @level = v
84
+ when 'WhiteListedEventTypes'
85
+ if v.nil?
86
+ @white_listed_event_types = []
87
+ else
88
+ @white_listed_event_types = Array.new(v.length)
89
+ v.each_with_index do |v1, i1|
90
+ raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
91
+
92
+ @white_listed_event_types[i1] = v1
93
+ end
94
+ end
77
95
  else
78
96
  @unknown_json_fields[k] = v
79
97
  end
@@ -84,8 +102,9 @@ module Comet
84
102
  def to_hash
85
103
  ret = {}
86
104
  ret['URL'] = @url
87
- ret['WhiteListedEventTypes'] = @white_listed_event_types
88
105
  ret['CustomHeaders'] = @custom_headers
106
+ ret['Level'] = @level
107
+ ret['WhiteListedEventTypes'] = @white_listed_event_types
89
108
  @unknown_json_fields.each do |k, v|
90
109
  ret[k] = v
91
110
  end
@@ -12,15 +12,21 @@ module Comet
12
12
  # WinSMBAuth is a typed class wrapper around the underlying Comet Server API data structure.
13
13
  class WinSMBAuth
14
14
 
15
+ # The UNC path for the Windows network share (SMB).
15
16
  # @type [String] share_path
16
17
  attr_accessor :share_path
17
18
 
19
+ # The username to log in to the Windows network share (SMB).
18
20
  # @type [String] username
19
21
  attr_accessor :username
20
22
 
23
+ # The password might be hashed. To set this in cleartext, set PasswordFormat to 0
24
+ # (PASSWORD_FORMAT_PLAINTEXT).
21
25
  # @type [String] password
22
26
  attr_accessor :password
23
27
 
28
+ # The hash algorithm that is used for the Password field. It is one of the PASSWORD_FORMAT_
29
+ # constants.
24
30
  # @type [Number] password_format
25
31
  attr_accessor :password_format
26
32
 
@@ -73,6 +73,7 @@ require_relative 'comet/models/external_authentication_source'
73
73
  require_relative 'comet/models/external_ldapauthentication_source_server'
74
74
  require_relative 'comet/models/external_ldapauthentication_source_settings'
75
75
  require_relative 'comet/models/extra_file_exclusion'
76
+ require_relative 'comet/models/file_option'
76
77
  require_relative 'comet/models/ftpdestination_location'
77
78
  require_relative 'comet/models/get_group_policy_response'
78
79
  require_relative 'comet/models/get_profile_and_hash_response_message'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: comet_backup_ruby_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.7.0
4
+ version: 2.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Comet Licensing Ltd.
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-24 00:00:00.000000000 Z
11
+ date: 2023-06-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -151,6 +151,7 @@ files:
151
151
  - lib/comet/models/external_ldapauthentication_source_server.rb
152
152
  - lib/comet/models/external_ldapauthentication_source_settings.rb
153
153
  - lib/comet/models/extra_file_exclusion.rb
154
+ - lib/comet/models/file_option.rb
154
155
  - lib/comet/models/ftpdestination_location.rb
155
156
  - lib/comet/models/get_group_policy_response.rb
156
157
  - lib/comet/models/get_profile_and_hash_response_message.rb