comet_backup_ruby_sdk 2.3.0 → 2.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (210) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -0
  3. data/.rubocop.yml +0 -0
  4. data/CHANGELOG.md +14 -0
  5. data/Gemfile +0 -0
  6. data/Gemfile.lock +1 -1
  7. data/LICENSE +0 -0
  8. data/README.md +0 -0
  9. data/RELEASING.md +0 -0
  10. data/Rakefile +0 -0
  11. data/comet_backup_ruby_sdk.gemspec +1 -1
  12. data/lib/comet/api_response_error.rb +1 -1
  13. data/lib/comet/comet_server.rb +114 -26
  14. data/lib/comet/definitions.rb +32 -6
  15. data/lib/comet/models/add_bucket_response_message.rb +1 -1
  16. data/lib/comet/models/admin_account_properties_response.rb +1 -1
  17. data/lib/comet/models/admin_email_options.rb +1 -1
  18. data/lib/comet/models/admin_resource_response.rb +1 -1
  19. data/lib/comet/models/admin_security_options.rb +1 -1
  20. data/lib/comet/models/admin_u2fregistration.rb +1 -1
  21. data/lib/comet/models/admin_user_permissions.rb +9 -1
  22. data/lib/comet/models/admin_web_authn_registration.rb +1 -1
  23. data/lib/comet/models/allowed_admin_user.rb +1 -1
  24. data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb +1 -1
  25. data/lib/comet/models/authentication_role_options.rb +1 -1
  26. data/lib/comet/models/available_download.rb +1 -1
  27. data/lib/comet/models/azure_destination_location.rb +1 -1
  28. data/lib/comet/models/b2destination_location.rb +1 -1
  29. data/lib/comet/models/b2storage_extra_info.rb +1 -1
  30. data/lib/comet/models/b2transaction_totals.rb +1 -1
  31. data/lib/comet/models/b2virtual_storage_role_settings.rb +1 -1
  32. data/lib/comet/models/backup_job_advanced_options.rb +1 -1
  33. data/lib/comet/models/backup_job_detail.rb +1 -1
  34. data/lib/comet/models/backup_job_progress.rb +1 -1
  35. data/lib/comet/models/backup_rule_config.rb +1 -1
  36. data/lib/comet/models/backup_rule_event_triggers.rb +1 -1
  37. data/lib/comet/models/branding_options.rb +1 -1
  38. data/lib/comet/models/branding_properties.rb +1 -1
  39. data/lib/comet/models/browse_disk_drives_response.rb +1 -1
  40. data/lib/comet/models/browse_edbresponse.rb +1 -1
  41. data/lib/comet/models/browse_hvresponse.rb +1 -1
  42. data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb +1 -1
  43. data/lib/comet/models/browse_office_365objects_response.rb +1 -1
  44. data/lib/comet/models/browse_sqlserver_response.rb +1 -1
  45. data/lib/comet/models/browse_vssresponse.rb +1 -1
  46. data/lib/comet/models/bucket_properties.rb +1 -1
  47. data/lib/comet/models/bucket_usage_info.rb +1 -1
  48. data/lib/comet/models/comet_apiresponse_message.rb +1 -1
  49. data/lib/comet/models/comet_destination_location.rb +1 -1
  50. data/lib/comet/models/constellation_check_report.rb +1 -1
  51. data/lib/comet/models/constellation_role_options.rb +1 -1
  52. data/lib/comet/models/constellation_stats.rb +1 -1
  53. data/lib/comet/models/constellation_status_apiresponse.rb +1 -1
  54. data/lib/comet/models/content_measurement.rb +1 -1
  55. data/lib/comet/models/content_measurement_component.rb +1 -1
  56. data/lib/comet/models/count_jobs_response.rb +73 -0
  57. data/lib/comet/models/create_group_policy_response.rb +1 -1
  58. data/lib/comet/models/custom_remote_bucket_settings.rb +1 -1
  59. data/lib/comet/models/days_of_week_config.rb +1 -1
  60. data/lib/comet/models/default_email_report_policy.rb +1 -1
  61. data/lib/comet/models/default_source_with_osrestriction.rb +1 -1
  62. data/lib/comet/models/destination_config.rb +1 -1
  63. data/lib/comet/models/destination_location.rb +1 -1
  64. data/lib/comet/models/destination_statistics.rb +1 -1
  65. data/lib/comet/models/device_config.rb +1 -1
  66. data/lib/comet/models/disk_drive.rb +1 -1
  67. data/lib/comet/models/dispatcher_admin_sources_response.rb +1 -1
  68. data/lib/comet/models/dispatcher_stored_objects_response.rb +1 -1
  69. data/lib/comet/models/dispatcher_vault_snapshots_response.rb +1 -1
  70. data/lib/comet/models/dispatcher_windisk_snapshot_response.rb +1 -1
  71. data/lib/comet/models/edbfile_info.rb +1 -1
  72. data/lib/comet/models/email_options.rb +27 -10
  73. data/lib/comet/models/email_report_config.rb +11 -1
  74. data/lib/comet/models/email_report_generated_preview.rb +1 -1
  75. data/lib/comet/models/email_reporting_option.rb +106 -0
  76. data/lib/comet/models/external_authentication_source.rb +1 -1
  77. data/lib/comet/models/external_ldapauthentication_source_server.rb +1 -1
  78. data/lib/comet/models/external_ldapauthentication_source_settings.rb +1 -1
  79. data/lib/comet/models/extra_file_exclusion.rb +1 -1
  80. data/lib/comet/models/ftpdestination_location.rb +1 -1
  81. data/lib/comet/models/get_group_policy_response.rb +1 -1
  82. data/lib/comet/models/get_profile_and_hash_response_message.rb +1 -1
  83. data/lib/comet/models/get_profile_hash_response_message.rb +1 -1
  84. data/lib/comet/models/global_override_options.rb +1 -1
  85. data/lib/comet/models/group_policy.rb +1 -1
  86. data/lib/comet/models/hour_sched_config.rb +1 -1
  87. data/lib/comet/models/httpconnector_options.rb +1 -1
  88. data/lib/comet/models/hyper_vmachine_info.rb +1 -1
  89. data/lib/comet/models/install_creds.rb +1 -1
  90. data/lib/comet/models/install_token.rb +1 -1
  91. data/lib/comet/models/install_token_response.rb +1 -1
  92. data/lib/comet/models/job_entry.rb +1 -1
  93. data/lib/comet/models/license_options.rb +1 -1
  94. data/lib/comet/models/live_user_connection.rb +1 -1
  95. data/lib/comet/models/local_destination_location.rb +1 -1
  96. data/lib/comet/models/local_storage_directory.rb +1 -1
  97. data/lib/comet/models/mac_oscode_sign_properties.rb +1 -1
  98. data/lib/comet/models/mongo_dbconnection.rb +2 -1
  99. data/lib/comet/models/mssqlconnection.rb +1 -1
  100. data/lib/comet/models/mssqllogin_args.rb +1 -1
  101. data/lib/comet/models/my_sqlconnection.rb +1 -1
  102. data/lib/comet/models/new_bucket_detail.rb +1 -1
  103. data/lib/comet/models/news_entry.rb +1 -1
  104. data/lib/comet/models/office_365connection.rb +1 -1
  105. data/lib/comet/models/office_365credential.rb +1 -1
  106. data/lib/comet/models/office_365custom_setting.rb +1 -1
  107. data/lib/comet/models/office_365custom_setting_v2.rb +1 -1
  108. data/lib/comet/models/office_365mixed_virtual_account.rb +1 -1
  109. data/lib/comet/models/office_365object_info.rb +1 -1
  110. data/lib/comet/models/organization.rb +1 -1
  111. data/lib/comet/models/organization_login_urlresponse.rb +1 -1
  112. data/lib/comet/models/organization_response.rb +1 -1
  113. data/lib/comet/models/osinfo.rb +1 -1
  114. data/lib/comet/models/partition.rb +1 -1
  115. data/lib/comet/models/private_branding_properties.rb +1 -1
  116. data/lib/comet/models/protected_item_engine_type_policy.rb +1 -1
  117. data/lib/comet/models/psaconfig.rb +21 -15
  118. data/lib/comet/models/public_branding_properties.rb +1 -1
  119. data/lib/comet/models/ratelimit_options.rb +1 -1
  120. data/lib/comet/models/ratelimit_rule.rb +1 -1
  121. data/lib/comet/models/register_office_application_begin_response.rb +1 -1
  122. data/lib/comet/models/register_office_application_check_response.rb +1 -1
  123. data/lib/comet/models/remote_server_address.rb +1 -1
  124. data/lib/comet/models/remote_storage_option.rb +1 -1
  125. data/lib/comet/models/replica_server.rb +1 -1
  126. data/lib/comet/models/replicator_state_apiresponse.rb +1 -1
  127. data/lib/comet/models/request_storage_vault_response_message.rb +1 -1
  128. data/lib/comet/models/restore_job_advanced_options.rb +1 -1
  129. data/lib/comet/models/retention_policy.rb +1 -1
  130. data/lib/comet/models/retention_range.rb +1 -1
  131. data/lib/comet/models/s3destination_location.rb +1 -1
  132. data/lib/comet/models/s3generic_virtual_storage_role.rb +1 -1
  133. data/lib/comet/models/schedule_config.rb +1 -1
  134. data/lib/comet/models/search_clause.rb +1 -1
  135. data/lib/comet/models/self_backup_export_options.rb +1 -1
  136. data/lib/comet/models/self_backup_options.rb +1 -1
  137. data/lib/comet/models/self_backup_statistics.rb +1 -1
  138. data/lib/comet/models/self_backup_target.rb +1 -1
  139. data/lib/comet/models/server_config_options.rb +123 -123
  140. data/lib/comet/models/server_config_options_branding_fragment.rb +1 -1
  141. data/lib/comet/models/server_config_options_software_build_role_fragment.rb +1 -1
  142. data/lib/comet/models/server_meta_branding_properties.rb +1 -1
  143. data/lib/comet/models/server_meta_version_info.rb +1 -1
  144. data/lib/comet/models/session_key_regenerated_response.rb +1 -1
  145. data/lib/comet/models/session_options.rb +1 -1
  146. data/lib/comet/models/sftpdestination_location.rb +1 -1
  147. data/lib/comet/models/single_field_source.rb +106 -0
  148. data/lib/comet/models/size_measurement.rb +1 -1
  149. data/lib/comet/models/software_build_role_options.rb +1 -1
  150. data/lib/comet/models/software_update_news_response.rb +1 -1
  151. data/lib/comet/models/source_basic_info.rb +10 -1
  152. data/lib/comet/models/source_config.rb +1 -1
  153. data/lib/comet/models/source_include_pattern.rb +1 -1
  154. data/lib/comet/models/source_statistics.rb +1 -1
  155. data/lib/comet/models/spanned_destination_location.rb +1 -1
  156. data/lib/comet/models/spanned_storage_extra_info.rb +1 -1
  157. data/lib/comet/models/sshconnection.rb +1 -1
  158. data/lib/comet/models/stat_result.rb +1 -1
  159. data/lib/comet/models/storage_free_space_info.rb +1 -1
  160. data/lib/comet/models/storage_role_options.rb +1 -1
  161. data/lib/comet/models/storage_vault_provider_policy.rb +1 -1
  162. data/lib/comet/models/stored_object.rb +1 -1
  163. data/lib/comet/models/storj_destination_location.rb +1 -1
  164. data/lib/comet/models/storj_virtual_storage_role_setting.rb +1 -1
  165. data/lib/comet/models/streamable_event.rb +1 -1
  166. data/lib/comet/models/swift_destination_location.rb +1 -1
  167. data/lib/comet/models/test_response.rb +1 -1
  168. data/lib/comet/models/time_span.rb +82 -0
  169. data/lib/comet/models/totp_regenerated_response.rb +1 -1
  170. data/lib/comet/models/u2fregister_request.rb +1 -1
  171. data/lib/comet/models/u2fregistered_key.rb +1 -1
  172. data/lib/comet/models/u2fregistration_challenge_response.rb +1 -1
  173. data/lib/comet/models/u2fsign_request.rb +1 -1
  174. data/lib/comet/models/u2fsign_response.rb +1 -1
  175. data/lib/comet/models/uninstall_config.rb +1 -1
  176. data/lib/comet/models/update_campaign_device_status.rb +1 -1
  177. data/lib/comet/models/update_campaign_options.rb +1 -1
  178. data/lib/comet/models/update_campaign_properties.rb +1 -1
  179. data/lib/comet/models/update_campaign_status.rb +1 -1
  180. data/lib/comet/models/update_campaign_status_device_entry.rb +1 -1
  181. data/lib/comet/models/user_custom_email_settings.rb +1 -1
  182. data/lib/comet/models/user_on_server.rb +1 -1
  183. data/lib/comet/models/user_policy.rb +1 -1
  184. data/lib/comet/models/user_profile_config.rb +21 -1
  185. data/lib/comet/models/user_profile_fragment.rb +1 -1
  186. data/lib/comet/models/user_server_config.rb +1 -1
  187. data/lib/comet/models/vault_snapshot.rb +1 -1
  188. data/lib/comet/models/vmdksnapshot_view_options.rb +10 -1
  189. data/lib/comet/models/vsscomponent.rb +1 -1
  190. data/lib/comet/models/vsswriter_info.rb +1 -1
  191. data/lib/comet/models/wasabi_virtual_storage_role_settings.rb +1 -1
  192. data/lib/comet/models/web_authn_authenticator_selection.rb +12 -1
  193. data/lib/comet/models/web_authn_credential.rb +1 -1
  194. data/lib/comet/models/web_authn_credential_assertion.rb +1 -1
  195. data/lib/comet/models/web_authn_credential_descriptor.rb +1 -1
  196. data/lib/comet/models/web_authn_credential_entity.rb +1 -1
  197. data/lib/comet/models/web_authn_credential_parameter.rb +1 -1
  198. data/lib/comet/models/web_authn_public_key_credential_creation_options.rb +1 -1
  199. data/lib/comet/models/web_authn_public_key_credential_request_options.rb +1 -1
  200. data/lib/comet/models/web_authn_registration_challenge_response.rb +1 -1
  201. data/lib/comet/models/web_authn_relying_party_entity.rb +1 -1
  202. data/lib/comet/models/web_authn_sign_request.rb +1 -1
  203. data/lib/comet/models/web_authn_sign_response.rb +1 -1
  204. data/lib/comet/models/web_authn_user_entity.rb +1 -1
  205. data/lib/comet/models/web_interface_branding_properties.rb +1 -1
  206. data/lib/comet/models/webhook_option.rb +1 -1
  207. data/lib/comet/models/win_smbauth.rb +1 -1
  208. data/lib/comet/models/windows_code_sign_properties.rb +1 -1
  209. data/lib/comet_backup_ruby_sdk.rb +5 -1
  210. metadata +6 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 00e37092c7f0ac13f7e37c577871acad5fb531e1e48160c8613d6028d4856bbc
4
- data.tar.gz: 8932a1d179e678dfcc8fdc5353df7ca48a08f056b519bba122fe40626d24b845
3
+ metadata.gz: 31d37f9db407cb918ddc8ef37463e6a0e5876adcb1c393b7139ec86631165c59
4
+ data.tar.gz: 4e418f15a2d9ef97ba7c6a1b01b33eea54e95080bbabfe4d595c084e402dabfe
5
5
  SHA512:
6
- metadata.gz: 287538a1a3801d13a90d86669f8c927ffe98af836539db452fc7303c98685baed99b0d150f72ba04eba853ba504340735f62970a001b4298cdcadc1b4654eb0a
7
- data.tar.gz: 8181631d4eeb1b01d79937045b1bacc5eac097245430ded01c07f9fa3078e10d3984c5b92c3dfe40986efaead8b599a312ea612ffa471b8beff749538bb39ba1
6
+ metadata.gz: ac49b81b1c33dcf60b72dff86a78ec6e22ca1fee9735c11e085928be4a55f73ecb0897a2fd27f93fa1196526cda9746c98c533c8778fb02cbfc92a21b355983f
7
+ data.tar.gz: e129d700eaa4a97048052e1636fd4fcad77db8a903af92e063b1e4c62b579aa98b77d0a4270df3e248abf459f781ec7b520e04b71e121de3bd9a1f362c03d8bd
data/.gitignore CHANGED
File without changes
data/.rubocop.yml CHANGED
File without changes
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 2023-02-15 v2.5.0
4
+ - Based on 22.12.8
5
+ - Add `TimeSpan` option to `EmailReportOptions`
6
+ - Add `AlertsDisabled` (default: false) toggle for `PSAConfig` objects
7
+ - Add `LastSuspended` for tracking `UserProfileConfig` suspensions
8
+ - Improve documentation
9
+
10
+ ## 2023-01-11 v2.4.0
11
+ - Based on 22.12.2
12
+ - Add new `AdminCountJobsForCustomSearchRequest` API to count total number of jobs for a given search query
13
+ - Add new `AdminMetaEmailOptionsGetRequest` / `AdminMetaEmailOptionsSetRequest` / `AdminMetaSendTestReportRequest` APIs for managing tenant email settings
14
+ - Add new O365 Protected Accounts quota option in the `UserProfileConfig`
15
+ - Add new tenant admin permission `AllowEditEmailOptions`
16
+
3
17
  ## 2022-12-09 v2.3.0
4
18
  - Based on 22.11.1
5
19
  - Support getCode() on exceptions to retrieve internal error code
data/Gemfile CHANGED
File without changes
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- comet_backup_ruby_sdk (2.3.0)
4
+ comet_backup_ruby_sdk (2.5.0)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
data/LICENSE CHANGED
File without changes
data/README.md CHANGED
File without changes
data/RELEASING.md CHANGED
File without changes
data/Rakefile CHANGED
File without changes
@@ -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.3.0'
15
+ spec.version = '2.5.0'
16
16
  spec.authors = ['Comet Licensing Ltd.']
17
17
  spec.email = ['hello@cometbackup.com']
18
18
 
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -388,7 +388,7 @@ module Comet
388
388
  #
389
389
  # You must supply administrator authentication credentials to use this API.
390
390
  # Access to this API may be prevented on a per-administrator basis.
391
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
391
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
392
392
  #
393
393
  # @param [String] target_user the username of the admin to be deleted
394
394
  # @return [Comet::CometAPIResponseMessage]
@@ -412,7 +412,7 @@ module Comet
412
412
  #
413
413
  # You must supply administrator authentication credentials to use this API.
414
414
  # Access to this API may be prevented on a per-administrator basis.
415
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
415
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
416
416
  #
417
417
  # @return [Array<Comet::AllowedAdminUser>]
418
418
  def admin_admin_user_list
@@ -437,7 +437,7 @@ module Comet
437
437
  #
438
438
  # You must supply administrator authentication credentials to use this API.
439
439
  # Access to this API may be prevented on a per-administrator basis.
440
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
440
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
441
441
  #
442
442
  # @param [String] target_user the username for this new admin
443
443
  # @param [String] target_password the password for this new admin user
@@ -874,7 +874,7 @@ module Comet
874
874
  # Prune unused buckets.
875
875
  #
876
876
  # You must supply administrator authentication credentials to use this API.
877
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
877
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
878
878
  # This API requires the Constellation Role to be enabled.
879
879
  #
880
880
  # @return [Comet::CometAPIResponseMessage]
@@ -904,6 +904,29 @@ module Comet
904
904
  ret
905
905
  end
906
906
 
907
+ # AdminCountJobsForCustomSearch
908
+ #
909
+ # Count jobs (for custom search).
910
+ #
911
+ # You must supply administrator authentication credentials to use this API.
912
+ # This API requires the Auth Role to be enabled.
913
+ #
914
+ # @param [Comet::SearchClause] query (No description available)
915
+ # @return [Comet::CountJobsResponse]
916
+ def admin_count_jobs_for_custom_search(query)
917
+ submit_params = {}
918
+ raise TypeError, "'query' expected Comet::SearchClause, got #{query.class}" unless query.is_a? Comet::SearchClause
919
+
920
+ submit_params['Query'] = query.to_json
921
+
922
+ body = perform_request('api/v1/admin/count-jobs-for-custom-search', submit_params)
923
+ json_body = JSON.parse body
924
+ check_status json_body
925
+ ret = Comet::CountJobsResponse.new
926
+ ret.from_hash(json_body)
927
+ ret
928
+ end
929
+
907
930
  # AdminCreateInstallToken
908
931
  #
909
932
  # Create token for silent installation.
@@ -1181,7 +1204,7 @@ module Comet
1181
1204
  #
1182
1205
  # You must supply administrator authentication credentials to use this API.
1183
1206
  # This API requires the Auth Role to be enabled.
1184
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
1207
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
1185
1208
  #
1186
1209
  # @param [String] organization_id Target organization
1187
1210
  # @return [Comet::OrganizationLoginURLResponse]
@@ -2510,7 +2533,7 @@ module Comet
2510
2533
  # AdminMetaBrandingConfigSet
2511
2534
  #
2512
2535
  # Set Branding configuration.
2513
- # Note that file resources must be provided using a resource URI I.E `"resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57"`. See AdminMetaResourceNew for the API documentation to create new file resources.
2536
+ # Note that file resources must be provided using a resource URI, i.e `"resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57"`. See AdminMetaResourceNew for the API documentation to create new file resources.
2514
2537
  #
2515
2538
  # You must supply administrator authentication credentials to use this API.
2516
2539
  # Access to this API may be prevented on a per-administrator basis.
@@ -2611,12 +2634,52 @@ module Comet
2611
2634
  ret
2612
2635
  end
2613
2636
 
2637
+ # AdminMetaEmailOptionsGet
2638
+ #
2639
+ # Get the email options.
2640
+ #
2641
+ # You must supply administrator authentication credentials to use this API.
2642
+ # Access to this API may be prevented on a per-administrator basis.
2643
+ #
2644
+ # @return [Comet::EmailOptions]
2645
+ def admin_meta_email_options_get
2646
+ body = perform_request('api/v1/admin/meta/email-options/get')
2647
+ json_body = JSON.parse body
2648
+ check_status json_body
2649
+ ret = Comet::EmailOptions.new
2650
+ ret.from_hash(json_body)
2651
+ ret
2652
+ end
2653
+
2654
+ # AdminMetaEmailOptionsSet
2655
+ #
2656
+ # Set the email options.
2657
+ #
2658
+ # You must supply administrator authentication credentials to use this API.
2659
+ # Access to this API may be prevented on a per-administrator basis.
2660
+ #
2661
+ # @param [Comet::EmailOptions] email_options The replacement email reporting options.
2662
+ # @return [Comet::CometAPIResponseMessage]
2663
+ def admin_meta_email_options_set(email_options)
2664
+ submit_params = {}
2665
+ raise TypeError, "'email_options' expected Comet::EmailOptions, got #{email_options.class}" unless email_options.is_a? Comet::EmailOptions
2666
+
2667
+ submit_params['EmailOptions'] = email_options.to_json
2668
+
2669
+ body = perform_request('api/v1/admin/meta/email-options/set', submit_params)
2670
+ json_body = JSON.parse body
2671
+ check_status json_body
2672
+ ret = Comet::CometAPIResponseMessage.new
2673
+ ret.from_hash(json_body)
2674
+ ret
2675
+ end
2676
+
2614
2677
  # AdminMetaListAvailableLogDays
2615
2678
  #
2616
2679
  # Get log files.
2617
2680
  #
2618
2681
  # You must supply administrator authentication credentials to use this API.
2619
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2682
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2620
2683
  #
2621
2684
  # @return [Array<Number>]
2622
2685
  def admin_meta_list_available_log_days
@@ -2706,7 +2769,7 @@ module Comet
2706
2769
  # This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
2707
2770
  #
2708
2771
  # You must supply administrator authentication credentials to use this API.
2709
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2772
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2710
2773
  #
2711
2774
  # @return [String]
2712
2775
  def admin_meta_read_all_logs
@@ -2720,7 +2783,7 @@ module Comet
2720
2783
  # This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
2721
2784
  #
2722
2785
  # You must supply administrator authentication credentials to use this API.
2723
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2786
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2724
2787
  #
2725
2788
  # @param [Number] log A log day, selected from the options returned by the Get Log Files API
2726
2789
  # @return [String]
@@ -2831,7 +2894,7 @@ module Comet
2831
2894
  # Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
2832
2895
  #
2833
2896
  # You must supply administrator authentication credentials to use this API.
2834
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2897
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2835
2898
  # Access to this API may be prevented on a per-administrator basis.
2836
2899
  #
2837
2900
  # @return [Comet::CometAPIResponseMessage]
@@ -2850,7 +2913,6 @@ module Comet
2850
2913
  # This allows the Comet Server web interface to support testing different email credentials during setup.
2851
2914
  #
2852
2915
  # You must supply administrator authentication credentials to use this API.
2853
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2854
2916
  # Access to this API may be prevented on a per-administrator basis.
2855
2917
  #
2856
2918
  # @param [Comet::EmailOptions] email_options Updated configuration content
@@ -2873,13 +2935,37 @@ module Comet
2873
2935
  ret
2874
2936
  end
2875
2937
 
2938
+ # AdminMetaSendTestReport
2939
+ #
2940
+ # Send a test admin email report.
2941
+ # This allows a user to send a test email report
2942
+ #
2943
+ # You must supply administrator authentication credentials to use this API.
2944
+ # Access to this API may be prevented on a per-administrator basis.
2945
+ #
2946
+ # @param [Comet::EmailReportingOption] email_reporting_option Test email reporting option for sending
2947
+ # @return [Comet::CometAPIResponseMessage]
2948
+ def admin_meta_send_test_report(email_reporting_option)
2949
+ submit_params = {}
2950
+ raise TypeError, "'email_reporting_option' expected Comet::EmailReportingOption, got #{email_reporting_option.class}" unless email_reporting_option.is_a? Comet::EmailReportingOption
2951
+
2952
+ submit_params['EmailReportingOption'] = email_reporting_option.to_json
2953
+
2954
+ body = perform_request('api/v1/admin/meta/send-test-report', submit_params)
2955
+ json_body = JSON.parse body
2956
+ check_status json_body
2957
+ ret = Comet::CometAPIResponseMessage.new
2958
+ ret.from_hash(json_body)
2959
+ ret
2960
+ end
2961
+
2876
2962
  # AdminMetaServerConfigGet
2877
2963
  #
2878
2964
  # Get server configuration.
2879
2965
  #
2880
2966
  # You must supply administrator authentication credentials to use this API.
2881
2967
  # Access to this API may be prevented on a per-administrator basis.
2882
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2968
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2883
2969
  #
2884
2970
  # @return [Comet::ServerConfigOptions]
2885
2971
  def admin_meta_server_config_get
@@ -2898,7 +2984,7 @@ module Comet
2898
2984
  #
2899
2985
  # You must supply administrator authentication credentials to use this API.
2900
2986
  # Access to this API may be prevented on a per-administrator basis.
2901
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2987
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2902
2988
  #
2903
2989
  # @return [Array<String>]
2904
2990
  def admin_meta_server_config_network_interfaces
@@ -2927,7 +3013,7 @@ module Comet
2927
3013
  #
2928
3014
  # You must supply administrator authentication credentials to use this API.
2929
3015
  # Access to this API may be prevented on a per-administrator basis.
2930
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3016
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2931
3017
  #
2932
3018
  # @param [Comet::ServerConfigOptions] config Updated configuration content
2933
3019
  # @return [Comet::CometAPIResponseMessage]
@@ -2953,7 +3039,7 @@ module Comet
2953
3039
  # Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
2954
3040
  #
2955
3041
  # You must supply administrator authentication credentials to use this API.
2956
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3042
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
2957
3043
  # Access to this API may be prevented on a per-administrator basis.
2958
3044
  #
2959
3045
  # @return [Comet::CometAPIResponseMessage]
@@ -3032,6 +3118,7 @@ module Comet
3032
3118
  # Get the server webhook configuration.
3033
3119
  #
3034
3120
  # You must supply administrator authentication credentials to use this API.
3121
+ # Access to this API may be prevented on a per-administrator basis.
3035
3122
  #
3036
3123
  # @return [Hash{String => Comet::WebhookOption}]
3037
3124
  def admin_meta_webhook_options_get
@@ -3056,6 +3143,7 @@ module Comet
3056
3143
  # Calling this endpoint will interrupt any messages currently queued for existing webhook destinations.
3057
3144
  #
3058
3145
  # You must supply administrator authentication credentials to use this API.
3146
+ # Access to this API may be prevented on a per-administrator basis.
3059
3147
  #
3060
3148
  # @param [Hash{String => Comet::WebhookOption}] webhook_options The replacement webhook target options.
3061
3149
  # @return [Comet::CometAPIResponseMessage]
@@ -3150,7 +3238,7 @@ module Comet
3150
3238
  # Prior to Comet 22.6.0, this API was documented as returning the OrganizationResponse type. However, it always has returned only a CometAPIResponseMessage.
3151
3239
  #
3152
3240
  # You must supply administrator authentication credentials to use this API.
3153
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3241
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3154
3242
  #
3155
3243
  # @param [String] organization_id (Optional) (No description available)
3156
3244
  # @param [Comet::UninstallConfig] uninstall_config (Optional) Uninstall software configuration
@@ -3181,7 +3269,7 @@ module Comet
3181
3269
  # Run self-backup for a specific tenant.
3182
3270
  #
3183
3271
  # You must supply administrator authentication credentials to use this API.
3184
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3272
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3185
3273
  #
3186
3274
  # @param [Comet::SelfBackupExportOptions] options The export config options
3187
3275
  # @return [Comet::CometAPIResponseMessage]
@@ -3204,7 +3292,7 @@ module Comet
3204
3292
  # List Organizations.
3205
3293
  #
3206
3294
  # You must supply administrator authentication credentials to use this API.
3207
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3295
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3208
3296
  #
3209
3297
  # @return [Hash{String => Comet::Organization}]
3210
3298
  def admin_organization_list
@@ -3230,7 +3318,7 @@ module Comet
3230
3318
  # Prior to Comet 22.6.0, the 'ID' and 'Organization' fields were not present in the response.
3231
3319
  #
3232
3320
  # You must supply administrator authentication credentials to use this API.
3233
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3321
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3234
3322
  #
3235
3323
  # @param [String] organization_id (Optional) (No description available)
3236
3324
  # @param [Comet::Organization] organization (Optional) (No description available)
@@ -3466,7 +3554,7 @@ module Comet
3466
3554
  # Get Replication status.
3467
3555
  #
3468
3556
  # You must supply administrator authentication credentials to use this API.
3469
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3557
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3470
3558
  #
3471
3559
  # @return [Array<Comet::ReplicatorStateAPIResponse>]
3472
3560
  def admin_replication_state
@@ -3623,7 +3711,7 @@ module Comet
3623
3711
  # Run self-backup on all targets.
3624
3712
  #
3625
3713
  # You must supply administrator authentication credentials to use this API.
3626
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3714
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3627
3715
  #
3628
3716
  # @return [Comet::CometAPIResponseMessage]
3629
3717
  def admin_self_backup_start
@@ -3756,7 +3844,7 @@ module Comet
3756
3844
  # You must supply administrator authentication credentials to use this API.
3757
3845
  # Access to this API may be prevented on a per-administrator basis.
3758
3846
  # This API requires the Storage Role to be enabled.
3759
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3847
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3760
3848
  #
3761
3849
  # @param [String] bucket_id (Optional) (This parameter is not used)
3762
3850
  # @return [Comet::StorageFreeSpaceInfo]
@@ -3807,7 +3895,7 @@ module Comet
3807
3895
  # You must supply administrator authentication credentials to use this API.
3808
3896
  # Access to this API may be prevented on a per-administrator basis.
3809
3897
  # This API requires the Storage Role to be enabled.
3810
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3898
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3811
3899
  #
3812
3900
  # @param [Comet::DestinationLocation] extra_data The destination location settings
3813
3901
  # @return [Comet::CometAPIResponseMessage]
@@ -3875,7 +3963,7 @@ module Comet
3875
3963
  # Start a new software update campaign.
3876
3964
  #
3877
3965
  # You must supply administrator authentication credentials to use this API.
3878
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3966
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3879
3967
  # This API requires the Software Build Role to be enabled.
3880
3968
  # This API requires the Auth Role to be enabled.
3881
3969
  #
@@ -3900,7 +3988,7 @@ module Comet
3900
3988
  # Get current campaign status.
3901
3989
  #
3902
3990
  # You must supply administrator authentication credentials to use this API.
3903
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3991
+ # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
3904
3992
  # This API requires the Software Build Role to be enabled.
3905
3993
  # This API requires the Auth Role to be enabled.
3906
3994
  #
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -147,6 +147,12 @@ module Comet
147
147
  # EmailReportType:
148
148
  EMAILREPORTTYPE_SUMMARY = 1
149
149
 
150
+ # EmailReportType:
151
+ EMAILREPORTTYPE_GROUPED_STATUS = 2
152
+
153
+ # EmailReportType:
154
+ EMAILREPORTTYPE_RECENT_ACTIVITY = 3
155
+
150
156
  # FtpsModeType:
151
157
  FTPS_MODE_PLAINTEXT = 0
152
158
 
@@ -443,6 +449,15 @@ module Comet
443
449
  # StoredObjectType:
444
450
  STOREDOBJECTTYPE_VMDK_SYMLINK = 'vmdksymlink'
445
451
 
452
+ # StoredObjectType:
453
+ STOREDOBJECTTYPE_VIRTUALIMAGE_DISK = 'virtualimagedisk'
454
+
455
+ # StoredObjectType:
456
+ STOREDOBJECTTYPE_VHDX_GPT_PARTITION = 'vhdxpartitiongpt'
457
+
458
+ # StoredObjectType:
459
+ STOREDOBJECTTYPE_VHDX_MBR_PARTITION = 'vhdxpartitionmbr'
460
+
446
461
  # ExtraFileExclusionOSRestriction:
447
462
  OS_ANY = 0
448
463
 
@@ -481,15 +496,15 @@ module Comet
481
496
 
482
497
  DEFAULT_TIMEZONE = 'UTC'
483
498
 
484
- APPLICATION_VERSION = '22.11.2'
499
+ APPLICATION_VERSION = '22.12.8'
485
500
 
486
501
  APPLICATION_VERSION_MAJOR = 22
487
502
 
488
- APPLICATION_VERSION_MINOR = 11
503
+ APPLICATION_VERSION_MINOR = 12
489
504
 
490
- APPLICATION_VERSION_REVISION = 2
505
+ APPLICATION_VERSION_REVISION = 8
491
506
 
492
- RELEASE_CODENAME = 'Ananke'
507
+ RELEASE_CODENAME = 'Voyager'
493
508
 
494
509
  ENCRYPTIONMETHOD_UNCONFIGURED = 0
495
510
 
@@ -501,6 +516,10 @@ module Comet
501
516
 
502
517
  UNSUPPORT_VMDK_FILE_SYSTEM = 'ERR_UNSUPPORT_VMDK_FILE_SYSTEM'
503
518
 
519
+ UNSUPPORT_VHDX_FILE_SYSTEM = 'ERR_UNSUPPORT_VHDX_FILE_SYSTEM'
520
+
521
+ VHDX_PARTITON_READ_ERR_MSG = 'ERR_VHDX_PARTITION'
522
+
504
523
  EMAIL_WORKER_STATE_NOT_STARTED = 0
505
524
 
506
525
  EMAIL_WORKER_STATE_STARTED = 1
@@ -639,7 +658,7 @@ module Comet
639
658
  SEARCHOPERATOR_BOOL_NIS = 'bool_nis'
640
659
 
641
660
  # EmailDeliveryType:
642
- EMAIL_DELIVERY_NONE = ''
661
+ EMAIL_DELIVERY_INHERIT = ''
643
662
 
644
663
  # EmailDeliveryType:
645
664
  EMAIL_DELIVERY_MX_DIRECT = 'builtin'
@@ -650,9 +669,16 @@ module Comet
650
669
  # EmailDeliveryType:
651
670
  EMAIL_DELIVERY_SMTP_SSL = 'smtp-ssl'
652
671
 
672
+ # EmailDeliveryType:
673
+ EMAIL_DELIVERY_DISABLED = 'disabled'
674
+
653
675
  # EmailDeliveryType: Legacy alias
654
676
  EMAIL_DELIVERY_BUILTIN = EMAIL_DELIVERY_MX_DIRECT
655
677
 
678
+ # EmailDeliveryType: changed for clarity
679
+ # @deprecated This const has been deprecated since Comet version 22.12.1
680
+ EMAIL_DELIVERY_NONE = EMAIL_DELIVERY_INHERIT
681
+
656
682
  # RemoteServerType:
657
683
  REMOTESERVER_COMET = 'comet'
658
684
 
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -24,6 +24,9 @@ module Comet
24
24
  # @type [Boolean] allow_edit_branding
25
25
  attr_accessor :allow_edit_branding
26
26
 
27
+ # @type [Boolean] allow_edit_email_options
28
+ attr_accessor :allow_edit_email_options
29
+
27
30
  # @type [Boolean] allow_edit_remote_storage
28
31
  attr_accessor :allow_edit_remote_storage
29
32
 
@@ -65,6 +68,8 @@ module Comet
65
68
  @prevent_change_password = v
66
69
  when 'AllowEditBranding'
67
70
  @allow_edit_branding = v
71
+ when 'AllowEditEmailOptions'
72
+ @allow_edit_email_options = v
68
73
  when 'AllowEditRemoteStorage'
69
74
  @allow_edit_remote_storage = v
70
75
  when 'AllowEditWebhooks'
@@ -92,6 +97,9 @@ module Comet
92
97
  unless @allow_edit_branding.nil?
93
98
  ret['AllowEditBranding'] = @allow_edit_branding
94
99
  end
100
+ unless @allow_edit_email_options.nil?
101
+ ret['AllowEditEmailOptions'] = @allow_edit_email_options
102
+ end
95
103
  unless @allow_edit_remote_storage.nil?
96
104
  ret['AllowEditRemoteStorage'] = @allow_edit_remote_storage
97
105
  end
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright (c) 2020-2022 Comet Licensing Ltd.
3
+ # Copyright (c) 2020-2023 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT