comet_backup_ruby_sdk 2.5.0 → 2.7.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 (205) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -2
  3. data/Gemfile.lock +1 -1
  4. data/comet_backup_ruby_sdk.gemspec +1 -1
  5. data/lib/comet/api_response_error.rb +0 -0
  6. data/lib/comet/comet_server.rb +71 -1
  7. data/lib/comet/definitions.rb +425 -401
  8. data/lib/comet/models/add_bucket_response_message.rb +0 -0
  9. data/lib/comet/models/admin_account_properties_response.rb +0 -0
  10. data/lib/comet/models/admin_email_options.rb +0 -0
  11. data/lib/comet/models/admin_resource_response.rb +0 -0
  12. data/lib/comet/models/admin_security_options.rb +0 -0
  13. data/lib/comet/models/admin_u2fregistration.rb +0 -0
  14. data/lib/comet/models/admin_user_permissions.rb +0 -0
  15. data/lib/comet/models/admin_web_authn_registration.rb +0 -0
  16. data/lib/comet/models/allowed_admin_user.rb +0 -0
  17. data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb +21 -0
  18. data/lib/comet/models/authentication_role_options.rb +0 -0
  19. data/lib/comet/models/available_download.rb +0 -0
  20. data/lib/comet/models/azure_destination_location.rb +0 -0
  21. data/lib/comet/models/b2destination_location.rb +0 -0
  22. data/lib/comet/models/b2storage_extra_info.rb +0 -0
  23. data/lib/comet/models/b2transaction_totals.rb +0 -0
  24. data/lib/comet/models/b2virtual_storage_role_settings.rb +0 -0
  25. data/lib/comet/models/backup_job_advanced_options.rb +0 -0
  26. data/lib/comet/models/backup_job_detail.rb +0 -0
  27. data/lib/comet/models/backup_job_progress.rb +0 -0
  28. data/lib/comet/models/backup_rule_config.rb +0 -0
  29. data/lib/comet/models/backup_rule_event_triggers.rb +0 -0
  30. data/lib/comet/models/branding_options.rb +82 -0
  31. data/lib/comet/models/branding_properties.rb +64 -0
  32. data/lib/comet/models/browse_disk_drives_response.rb +0 -0
  33. data/lib/comet/models/browse_edbresponse.rb +0 -0
  34. data/lib/comet/models/browse_hvresponse.rb +0 -0
  35. data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb +0 -0
  36. data/lib/comet/models/browse_office_365objects_response.rb +0 -0
  37. data/lib/comet/models/browse_sqlserver_response.rb +0 -0
  38. data/lib/comet/models/browse_vssresponse.rb +0 -0
  39. data/lib/comet/models/bucket_properties.rb +0 -0
  40. data/lib/comet/models/bucket_usage_info.rb +0 -0
  41. data/lib/comet/models/comet_apiresponse_message.rb +0 -0
  42. data/lib/comet/models/comet_destination_location.rb +0 -0
  43. data/lib/comet/models/constellation_check_report.rb +0 -0
  44. data/lib/comet/models/constellation_role_options.rb +0 -0
  45. data/lib/comet/models/constellation_stats.rb +0 -0
  46. data/lib/comet/models/constellation_status_apiresponse.rb +0 -0
  47. data/lib/comet/models/content_measurement.rb +0 -0
  48. data/lib/comet/models/content_measurement_component.rb +0 -0
  49. data/lib/comet/models/count_jobs_response.rb +0 -0
  50. data/lib/comet/models/create_group_policy_response.rb +0 -0
  51. data/lib/comet/models/custom_remote_bucket_settings.rb +0 -0
  52. data/lib/comet/models/days_of_week_config.rb +0 -0
  53. data/lib/comet/models/default_email_report_policy.rb +0 -0
  54. data/lib/comet/models/default_source_with_osrestriction.rb +0 -0
  55. data/lib/comet/models/destination_config.rb +15 -0
  56. data/lib/comet/models/destination_location.rb +15 -0
  57. data/lib/comet/models/destination_statistics.rb +0 -0
  58. data/lib/comet/models/device_config.rb +0 -0
  59. data/lib/comet/models/disk_drive.rb +0 -0
  60. data/lib/comet/models/dispatcher_admin_sources_response.rb +0 -0
  61. data/lib/comet/models/dispatcher_stored_objects_response.rb +0 -0
  62. data/lib/comet/models/dispatcher_vault_snapshots_response.rb +0 -0
  63. data/lib/comet/models/dispatcher_windisk_snapshot_response.rb +0 -0
  64. data/lib/comet/models/edbfile_info.rb +0 -0
  65. data/lib/comet/models/email_options.rb +0 -0
  66. data/lib/comet/models/email_report_config.rb +0 -0
  67. data/lib/comet/models/email_report_generated_preview.rb +0 -0
  68. data/lib/comet/models/email_reporting_option.rb +0 -0
  69. data/lib/comet/models/external_authentication_source.rb +0 -0
  70. data/lib/comet/models/external_ldapauthentication_source_server.rb +0 -0
  71. data/lib/comet/models/external_ldapauthentication_source_settings.rb +0 -0
  72. data/lib/comet/models/extra_file_exclusion.rb +0 -0
  73. data/lib/comet/models/ftpdestination_location.rb +0 -0
  74. data/lib/comet/models/get_group_policy_response.rb +0 -0
  75. data/lib/comet/models/get_profile_and_hash_response_message.rb +0 -0
  76. data/lib/comet/models/get_profile_hash_response_message.rb +0 -0
  77. data/lib/comet/models/global_override_options.rb +0 -0
  78. data/lib/comet/models/group_policy.rb +18 -0
  79. data/lib/comet/models/hour_sched_config.rb +0 -0
  80. data/lib/comet/models/httpconnector_options.rb +0 -0
  81. data/lib/comet/models/hyper_vmachine_info.rb +0 -0
  82. data/lib/comet/models/install_creds.rb +0 -0
  83. data/lib/comet/models/install_token.rb +0 -0
  84. data/lib/comet/models/install_token_response.rb +0 -0
  85. data/lib/comet/models/job_entry.rb +0 -0
  86. data/lib/comet/models/license_options.rb +0 -0
  87. data/lib/comet/models/live_user_connection.rb +0 -0
  88. data/lib/comet/models/local_destination_location.rb +0 -0
  89. data/lib/comet/models/local_storage_directory.rb +0 -0
  90. data/lib/comet/models/mac_oscode_sign_properties.rb +0 -0
  91. data/lib/comet/models/mongo_dbconnection.rb +0 -0
  92. data/lib/comet/models/mssqlconnection.rb +0 -0
  93. data/lib/comet/models/mssqllogin_args.rb +0 -0
  94. data/lib/comet/models/my_sqlconnection.rb +0 -0
  95. data/lib/comet/models/new_bucket_detail.rb +0 -0
  96. data/lib/comet/models/news_entry.rb +0 -0
  97. data/lib/comet/models/office_365connection.rb +0 -0
  98. data/lib/comet/models/office_365credential.rb +0 -0
  99. data/lib/comet/models/office_365custom_setting.rb +0 -0
  100. data/lib/comet/models/office_365custom_setting_v2.rb +0 -0
  101. data/lib/comet/models/office_365mixed_virtual_account.rb +0 -0
  102. data/lib/comet/models/office_365object_info.rb +0 -0
  103. data/lib/comet/models/organization.rb +0 -0
  104. data/lib/comet/models/organization_login_urlresponse.rb +0 -0
  105. data/lib/comet/models/organization_response.rb +0 -0
  106. data/lib/comet/models/osinfo.rb +0 -0
  107. data/lib/comet/models/partition.rb +0 -0
  108. data/lib/comet/models/private_branding_properties.rb +64 -0
  109. data/lib/comet/models/protected_item_engine_type_policy.rb +0 -0
  110. data/lib/comet/models/psaconfig.rb +0 -0
  111. data/lib/comet/models/public_branding_properties.rb +0 -0
  112. data/lib/comet/models/ratelimit_options.rb +0 -0
  113. data/lib/comet/models/ratelimit_rule.rb +0 -0
  114. data/lib/comet/models/register_office_application_begin_response.rb +0 -0
  115. data/lib/comet/models/register_office_application_check_response.rb +0 -0
  116. data/lib/comet/models/remote_server_address.rb +0 -0
  117. data/lib/comet/models/remote_storage_option.rb +0 -0
  118. data/lib/comet/models/replica_server.rb +0 -0
  119. data/lib/comet/models/replicator_state_apiresponse.rb +0 -0
  120. data/lib/comet/models/request_storage_vault_response_message.rb +0 -0
  121. data/lib/comet/models/restore_job_advanced_options.rb +0 -0
  122. data/lib/comet/models/retention_policy.rb +0 -0
  123. data/lib/comet/models/retention_range.rb +0 -0
  124. data/lib/comet/models/s3destination_location.rb +15 -0
  125. data/lib/comet/models/s3generic_virtual_storage_role.rb +21 -0
  126. data/lib/comet/models/schedule_config.rb +0 -0
  127. data/lib/comet/models/search_clause.rb +0 -0
  128. data/lib/comet/models/search_result_file_info.rb +136 -0
  129. data/lib/comet/models/search_snapshots_response.rb +104 -0
  130. data/lib/comet/models/self_backup_export_options.rb +6 -0
  131. data/lib/comet/models/self_backup_options.rb +0 -0
  132. data/lib/comet/models/self_backup_statistics.rb +0 -0
  133. data/lib/comet/models/self_backup_target.rb +6 -0
  134. data/lib/comet/models/server_config_options.rb +0 -0
  135. data/lib/comet/models/server_config_options_branding_fragment.rb +0 -0
  136. data/lib/comet/models/server_config_options_software_build_role_fragment.rb +0 -0
  137. data/lib/comet/models/server_meta_branding_properties.rb +9 -0
  138. data/lib/comet/models/server_meta_version_info.rb +0 -0
  139. data/lib/comet/models/session_key_regenerated_response.rb +0 -0
  140. data/lib/comet/models/session_options.rb +0 -0
  141. data/lib/comet/models/sftpdestination_location.rb +0 -0
  142. data/lib/comet/models/single_field_source.rb +0 -0
  143. data/lib/comet/models/size_measurement.rb +0 -0
  144. data/lib/comet/models/software_build_role_options.rb +0 -0
  145. data/lib/comet/models/software_update_news_response.rb +0 -0
  146. data/lib/comet/models/source_basic_info.rb +0 -0
  147. data/lib/comet/models/source_config.rb +0 -0
  148. data/lib/comet/models/source_include_pattern.rb +0 -0
  149. data/lib/comet/models/source_statistics.rb +0 -0
  150. data/lib/comet/models/spanned_destination_location.rb +0 -0
  151. data/lib/comet/models/spanned_storage_extra_info.rb +0 -0
  152. data/lib/comet/models/sshconnection.rb +0 -0
  153. data/lib/comet/models/stat_result.rb +0 -0
  154. data/lib/comet/models/storage_free_space_info.rb +0 -0
  155. data/lib/comet/models/storage_role_options.rb +0 -0
  156. data/lib/comet/models/storage_vault_provider_policy.rb +0 -0
  157. data/lib/comet/models/stored_object.rb +0 -0
  158. data/lib/comet/models/storj_destination_location.rb +0 -0
  159. data/lib/comet/models/storj_virtual_storage_role_setting.rb +0 -0
  160. data/lib/comet/models/streamable_event.rb +0 -0
  161. data/lib/comet/models/swift_destination_location.rb +0 -0
  162. data/lib/comet/models/test_response.rb +0 -0
  163. data/lib/comet/models/time_span.rb +0 -0
  164. data/lib/comet/models/totp_regenerated_response.rb +0 -0
  165. data/lib/comet/models/u2fregister_request.rb +0 -0
  166. data/lib/comet/models/u2fregistered_key.rb +0 -0
  167. data/lib/comet/models/u2fregistration_challenge_response.rb +0 -0
  168. data/lib/comet/models/u2fsign_request.rb +0 -0
  169. data/lib/comet/models/u2fsign_response.rb +0 -0
  170. data/lib/comet/models/uninstall_config.rb +0 -0
  171. data/lib/comet/models/update_campaign_device_status.rb +0 -0
  172. data/lib/comet/models/update_campaign_options.rb +0 -0
  173. data/lib/comet/models/update_campaign_properties.rb +0 -0
  174. data/lib/comet/models/update_campaign_status.rb +0 -0
  175. data/lib/comet/models/update_campaign_status_device_entry.rb +0 -0
  176. data/lib/comet/models/user_custom_email_settings.rb +0 -0
  177. data/lib/comet/models/user_on_server.rb +0 -0
  178. data/lib/comet/models/user_policy.rb +0 -0
  179. data/lib/comet/models/user_profile_config.rb +0 -0
  180. data/lib/comet/models/user_profile_fragment.rb +0 -0
  181. data/lib/comet/models/user_server_config.rb +0 -0
  182. data/lib/comet/models/vault_snapshot.rb +0 -0
  183. data/lib/comet/models/vmdksnapshot_view_options.rb +0 -0
  184. data/lib/comet/models/vsscomponent.rb +0 -0
  185. data/lib/comet/models/vsswriter_info.rb +0 -0
  186. data/lib/comet/models/wasabi_virtual_storage_role_settings.rb +21 -0
  187. data/lib/comet/models/web_authn_authenticator_selection.rb +0 -0
  188. data/lib/comet/models/web_authn_credential.rb +0 -0
  189. data/lib/comet/models/web_authn_credential_assertion.rb +0 -0
  190. data/lib/comet/models/web_authn_credential_descriptor.rb +0 -0
  191. data/lib/comet/models/web_authn_credential_entity.rb +0 -0
  192. data/lib/comet/models/web_authn_credential_parameter.rb +0 -0
  193. data/lib/comet/models/web_authn_public_key_credential_creation_options.rb +0 -0
  194. data/lib/comet/models/web_authn_public_key_credential_request_options.rb +0 -0
  195. data/lib/comet/models/web_authn_registration_challenge_response.rb +0 -0
  196. data/lib/comet/models/web_authn_relying_party_entity.rb +0 -0
  197. data/lib/comet/models/web_authn_sign_request.rb +0 -0
  198. data/lib/comet/models/web_authn_sign_response.rb +0 -0
  199. data/lib/comet/models/web_authn_user_entity.rb +0 -0
  200. data/lib/comet/models/web_interface_branding_properties.rb +18 -0
  201. data/lib/comet/models/webhook_option.rb +0 -0
  202. data/lib/comet/models/win_smbauth.rb +0 -0
  203. data/lib/comet/models/windows_code_sign_properties.rb +64 -0
  204. data/lib/comet_backup_ruby_sdk.rb +2 -0
  205. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 31d37f9db407cb918ddc8ef37463e6a0e5876adcb1c393b7139ec86631165c59
4
- data.tar.gz: 4e418f15a2d9ef97ba7c6a1b01b33eea54e95080bbabfe4d595c084e402dabfe
3
+ metadata.gz: 2343c8ab5eb2780d894920a96b4c770e7f2c25535e6bb2f11dc47167ece4b504
4
+ data.tar.gz: ce4fdb0e3c4d253f2573d230d0fc2f1a726bc0483805198dfcb27584a7fc956e
5
5
  SHA512:
6
- metadata.gz: ac49b81b1c33dcf60b72dff86a78ec6e22ca1fee9735c11e085928be4a55f73ecb0897a2fd27f93fa1196526cda9746c98c533c8778fb02cbfc92a21b355983f
7
- data.tar.gz: e129d700eaa4a97048052e1636fd4fcad77db8a903af92e063b1e4c62b579aa98b77d0a4270df3e248abf459f781ec7b520e04b71e121de3bd9a1f362c03d8bd
6
+ metadata.gz: b49b8e8fe346fdffc94843b438a5ced538d19ed3e6dba340b2357d841aa169b34d284ad9866baf8e62af4ec6ab3516ab0d8c2df4f446f589d50f5f06bf886baf
7
+ data.tar.gz: ae85553f2ce9c8433351d38a8c72c2b755bfd64cd525a4afd20afb69fd1672c371d92d82b697717fe761a85c5edf3163a9f66fd16e11d5cce59c1458fcee04ac
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
- # CHANGELOG
2
-
1
+ # CHANGELOG
2
+
3
+ ## 2023-04-24 v2.7.0
4
+
5
+ - Based on Comet 23.3.5
6
+ - Support new `AdminDispatcherSearchSnapshots` API to remotely search for files in a Storage Vault
7
+ - Support new `AdminMetaRemoteStorageVaultTest` API to test connections for a Storage Template
8
+ - Support new `AccentColor` and `BrandingStyleType` branding options for the Comet Server web interface
9
+ - New Self-Backup option to include server logs
10
+ - Track creation and modification timestamps for `GroupPolicy` objects
11
+
12
+ ## 2023-03-23 v2.6.0
13
+
14
+ - Based on Comet 23.3.1
15
+ - Support filter parameters on `AdminGetJobLogEntries`
16
+ - Support S3 Object Lock
17
+ - Support Azure Key Vault codesigning
18
+
3
19
  ## 2023-02-15 v2.5.0
4
20
  - Based on 22.12.8
5
21
  - Add `TimeSpan` option to `EmailReportOptions`
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- comet_backup_ruby_sdk (2.5.0)
4
+ comet_backup_ruby_sdk (2.7.0)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
12
12
 
13
13
  Gem::Specification.new do |spec|
14
14
  spec.name = 'comet_backup_ruby_sdk'
15
- spec.version = '2.5.0'
15
+ spec.version = '2.7.0'
16
16
  spec.authors = ['Comet Licensing Ltd.']
17
17
  spec.email = ['hello@cometbackup.com']
18
18
 
File without changes
@@ -2017,6 +2017,41 @@ module Comet
2017
2017
  ret
2018
2018
  end
2019
2019
 
2020
+ # AdminDispatcherSearchSnapshots
2021
+ #
2022
+ # Search storage vault snapshots.
2023
+ #
2024
+ # You must supply administrator authentication credentials to use this API.
2025
+ # This API requires the Auth Role to be enabled.
2026
+ #
2027
+ # @param [String] target_id The live connection GUID
2028
+ # @param [String] destination_id The Storage Vault GUID
2029
+ # @param [Array<String>] snapshot_ids Snapshots to search
2030
+ # @param [Comet::SearchClause] filter The search filter
2031
+ # @return [Comet::SearchSnapshotsResponse]
2032
+ def admin_dispatcher_search_snapshots(target_id, destination_id, snapshot_ids, filter)
2033
+ submit_params = {}
2034
+ raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
2035
+
2036
+ submit_params['TargetID'] = target_id
2037
+ raise TypeError, "'destination_id' expected String, got #{destination_id.class}" unless destination_id.is_a? String
2038
+
2039
+ submit_params['DestinationID'] = destination_id
2040
+ raise TypeError, "'snapshot_ids' expected Array, got #{snapshot_ids.class}" unless snapshot_ids.is_a? Array
2041
+
2042
+ submit_params['SnapshotIDs'] = snapshot_ids.to_json
2043
+ raise TypeError, "'filter' expected Comet::SearchClause, got #{filter.class}" unless filter.is_a? Comet::SearchClause
2044
+
2045
+ submit_params['Filter'] = filter.to_json
2046
+
2047
+ body = perform_request('api/v1/admin/dispatcher/search-snapshots', submit_params)
2048
+ json_body = JSON.parse body
2049
+ check_status json_body
2050
+ ret = Comet::SearchSnapshotsResponse.new
2051
+ ret.from_hash(json_body)
2052
+ ret
2053
+ end
2054
+
2020
2055
  # AdminDispatcherUninstallSoftware
2021
2056
  #
2022
2057
  # Instruct a live connected device to self-uninstall the software.
@@ -2161,12 +2196,24 @@ module Comet
2161
2196
  # This API requires the Auth Role to be enabled.
2162
2197
  #
2163
2198
  # @param [String] job_id Selected job ID
2199
+ # @param [String] min_severity (Optional) Return only job log entries with equal or higher severity
2200
+ # @param [String] message_contains (Optional) Return only job log entries that contain exact string
2164
2201
  # @return [Array<Comet::JobEntry>]
2165
- def admin_get_job_log_entries(job_id)
2202
+ def admin_get_job_log_entries(job_id, min_severity = nil, message_contains = nil)
2166
2203
  submit_params = {}
2167
2204
  raise TypeError, "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String
2168
2205
 
2169
2206
  submit_params['JobID'] = job_id
2207
+ unless min_severity.nil?
2208
+ raise TypeError, "'min_severity' expected String, got #{min_severity.class}" unless min_severity.is_a? String
2209
+
2210
+ submit_params['MinSeverity'] = min_severity
2211
+ end
2212
+ unless message_contains.nil?
2213
+ raise TypeError, "'message_contains' expected String, got #{message_contains.class}" unless message_contains.is_a? String
2214
+
2215
+ submit_params['MessageContains'] = message_contains
2216
+ end
2170
2217
 
2171
2218
  body = perform_request('api/v1/admin/get-job-log-entries', submit_params)
2172
2219
  json_body = JSON.parse body
@@ -2843,6 +2890,29 @@ module Comet
2843
2890
  ret
2844
2891
  end
2845
2892
 
2893
+ # AdminMetaRemoteStorageVaultTest
2894
+ #
2895
+ # Test the connection to the storage template.
2896
+ #
2897
+ # You must supply administrator authentication credentials to use this API.
2898
+ # Access to this API may be prevented on a per-administrator basis.
2899
+ #
2900
+ # @param [Comet::RemoteStorageOption] template_options Storage Template Vault Options
2901
+ # @return [Comet::CometAPIResponseMessage]
2902
+ def admin_meta_remote_storage_vault_test(template_options)
2903
+ submit_params = {}
2904
+ raise TypeError, "'template_options' expected Comet::RemoteStorageOption, got #{template_options.class}" unless template_options.is_a? Comet::RemoteStorageOption
2905
+
2906
+ submit_params['TemplateOptions'] = template_options.to_json
2907
+
2908
+ body = perform_request('api/v1/admin/meta/remote-storage-vault/test', submit_params)
2909
+ json_body = JSON.parse body
2910
+ check_status json_body
2911
+ ret = Comet::CometAPIResponseMessage.new
2912
+ ret.from_hash(json_body)
2913
+ ret
2914
+ end
2915
+
2846
2916
  # AdminMetaResourceGet
2847
2917
  #
2848
2918
  # Get a resource file.