comet_backup_ruby_sdk 1.15.0 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -0
  3. data/.rubocop.yml +0 -0
  4. data/CHANGELOG.md +28 -1
  5. data/Gemfile +2 -4
  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 +2 -4
  11. data/comet_backup_ruby_sdk.gemspec +1 -1
  12. data/lib/comet/api_response_error.rb +2 -4
  13. data/lib/comet/comet_server.rb +76 -23
  14. data/lib/comet/definitions.rb +28 -7
  15. data/lib/comet/models/add_bucket_response_message.rb +2 -4
  16. data/lib/comet/models/admin_account_properties_response.rb +2 -4
  17. data/lib/comet/models/admin_email_options.rb +2 -4
  18. data/lib/comet/models/admin_resource_response.rb +2 -4
  19. data/lib/comet/models/admin_security_options.rb +2 -4
  20. data/lib/comet/models/admin_u2fregistration.rb +2 -4
  21. data/lib/comet/models/admin_user_permissions.rb +18 -4
  22. data/lib/comet/models/admin_web_authn_registration.rb +2 -4
  23. data/lib/comet/models/allowed_admin_user.rb +2 -4
  24. data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb +2 -4
  25. data/lib/comet/models/authentication_role_options.rb +149 -0
  26. data/lib/comet/models/available_download.rb +2 -4
  27. data/lib/comet/models/azure_destination_location.rb +2 -4
  28. data/lib/comet/models/b2destination_location.rb +2 -4
  29. data/lib/comet/models/b2storage_extra_info.rb +2 -4
  30. data/lib/comet/models/b2transaction_totals.rb +2 -4
  31. data/lib/comet/models/b2virtual_storage_role_settings.rb +2 -4
  32. data/lib/comet/models/backup_job_advanced_options.rb +2 -4
  33. data/lib/comet/models/backup_job_detail.rb +2 -4
  34. data/lib/comet/models/backup_job_progress.rb +2 -4
  35. data/lib/comet/models/backup_rule_config.rb +2 -4
  36. data/lib/comet/models/backup_rule_event_triggers.rb +2 -4
  37. data/lib/comet/models/branding_options.rb +11 -4
  38. data/lib/comet/models/branding_properties.rb +11 -4
  39. data/lib/comet/models/browse_disk_drives_response.rb +2 -4
  40. data/lib/comet/models/browse_edbresponse.rb +2 -4
  41. data/lib/comet/models/browse_hvresponse.rb +2 -4
  42. data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb +2 -4
  43. data/lib/comet/models/browse_office_365objects_response.rb +2 -4
  44. data/lib/comet/models/browse_sqlserver_response.rb +2 -4
  45. data/lib/comet/models/browse_vssresponse.rb +2 -4
  46. data/lib/comet/models/bucket_properties.rb +2 -4
  47. data/lib/comet/models/bucket_usage_info.rb +11 -4
  48. data/lib/comet/models/comet_apiresponse_message.rb +2 -4
  49. data/lib/comet/models/comet_destination_location.rb +2 -4
  50. data/lib/comet/models/constellation_check_report.rb +2 -4
  51. data/lib/comet/models/constellation_role_options.rb +91 -0
  52. data/lib/comet/models/constellation_stats.rb +2 -4
  53. data/lib/comet/models/constellation_status_apiresponse.rb +2 -4
  54. data/lib/comet/models/content_measurement.rb +2 -4
  55. data/lib/comet/models/content_measurement_component.rb +2 -4
  56. data/lib/comet/models/create_group_policy_response.rb +2 -4
  57. data/lib/comet/models/custom_remote_bucket_settings.rb +2 -4
  58. data/lib/comet/models/days_of_week_config.rb +2 -4
  59. data/lib/comet/models/default_email_report_policy.rb +2 -4
  60. data/lib/comet/models/default_source_with_osrestriction.rb +2 -4
  61. data/lib/comet/models/destination_config.rb +19 -4
  62. data/lib/comet/models/destination_location.rb +19 -4
  63. data/lib/comet/models/destination_statistics.rb +2 -4
  64. data/lib/comet/models/device_config.rb +2 -4
  65. data/lib/comet/models/disk_drive.rb +2 -4
  66. data/lib/comet/models/dispatcher_admin_sources_response.rb +2 -4
  67. data/lib/comet/models/dispatcher_stored_objects_response.rb +2 -4
  68. data/lib/comet/models/dispatcher_vault_snapshots_response.rb +2 -4
  69. data/lib/comet/models/dispatcher_windisk_snapshot_response.rb +2 -4
  70. data/lib/comet/models/edbfile_info.rb +2 -4
  71. data/lib/comet/models/email_options.rb +2 -4
  72. data/lib/comet/models/email_report_config.rb +2 -4
  73. data/lib/comet/models/email_report_generated_preview.rb +2 -4
  74. data/lib/comet/models/external_authentication_source.rb +194 -0
  75. data/lib/comet/models/external_ldapauthentication_source_server.rb +97 -0
  76. data/lib/comet/models/external_ldapauthentication_source_settings.rb +23 -10
  77. data/lib/comet/models/extra_file_exclusion.rb +2 -4
  78. data/lib/comet/models/ftpdestination_location.rb +2 -4
  79. data/lib/comet/models/get_group_policy_response.rb +2 -4
  80. data/lib/comet/models/get_profile_and_hash_response_message.rb +2 -4
  81. data/lib/comet/models/get_profile_hash_response_message.rb +2 -4
  82. data/lib/comet/models/global_override_options.rb +75 -0
  83. data/lib/comet/models/group_policy.rb +2 -4
  84. data/lib/comet/models/hour_sched_config.rb +2 -4
  85. data/lib/comet/models/httpconnector_options.rb +139 -0
  86. data/lib/comet/models/hyper_vmachine_info.rb +2 -4
  87. data/lib/comet/models/install_creds.rb +2 -4
  88. data/lib/comet/models/install_token.rb +2 -4
  89. data/lib/comet/models/install_token_response.rb +2 -4
  90. data/lib/comet/models/job_entry.rb +2 -4
  91. data/lib/comet/models/license_options.rb +84 -0
  92. data/lib/comet/models/live_user_connection.rb +2 -4
  93. data/lib/comet/models/local_destination_location.rb +2 -4
  94. data/lib/comet/models/local_storage_directory.rb +73 -0
  95. data/lib/comet/models/mac_oscode_sign_properties.rb +2 -4
  96. data/lib/comet/models/mongo_dbconnection.rb +2 -4
  97. data/lib/comet/models/mssqlconnection.rb +2 -4
  98. data/lib/comet/models/my_sqlconnection.rb +2 -4
  99. data/lib/comet/models/new_bucket_detail.rb +2 -4
  100. data/lib/comet/models/news_entry.rb +2 -4
  101. data/lib/comet/models/office_365connection.rb +2 -4
  102. data/lib/comet/models/office_365credential.rb +2 -4
  103. data/lib/comet/models/office_365custom_setting.rb +2 -4
  104. data/lib/comet/models/office_365custom_setting_v2.rb +2 -4
  105. data/lib/comet/models/office_365mixed_virtual_account.rb +13 -4
  106. data/lib/comet/models/office_365object_info.rb +2 -4
  107. data/lib/comet/models/organization.rb +13 -7
  108. data/lib/comet/models/organization_response.rb +2 -4
  109. data/lib/comet/models/osinfo.rb +2 -4
  110. data/lib/comet/models/partition.rb +2 -4
  111. data/lib/comet/models/private_branding_properties.rb +11 -4
  112. data/lib/comet/models/protected_item_engine_type_policy.rb +2 -4
  113. data/lib/comet/models/public_branding_properties.rb +2 -4
  114. data/lib/comet/models/ratelimit_options.rb +81 -0
  115. data/lib/comet/models/ratelimit_rule.rb +82 -0
  116. data/lib/comet/models/register_office_application_begin_response.rb +2 -4
  117. data/lib/comet/models/register_office_application_check_response.rb +2 -4
  118. data/lib/comet/models/remote_server_address.rb +12 -4
  119. data/lib/comet/models/remote_storage_option.rb +12 -4
  120. data/lib/comet/models/replica_server.rb +197 -0
  121. data/lib/comet/models/replicator_state_apiresponse.rb +2 -4
  122. data/lib/comet/models/request_storage_vault_response_message.rb +2 -4
  123. data/lib/comet/models/restore_job_advanced_options.rb +83 -4
  124. data/lib/comet/models/retention_policy.rb +2 -4
  125. data/lib/comet/models/retention_range.rb +2 -4
  126. data/lib/comet/models/s3destination_location.rb +11 -4
  127. data/lib/comet/models/s3generic_virtual_storage_role.rb +2 -4
  128. data/lib/comet/models/schedule_config.rb +13 -4
  129. data/lib/comet/models/search_clause.rb +2 -4
  130. data/lib/comet/models/self_backup_options.rb +79 -0
  131. data/lib/comet/models/self_backup_statistics.rb +2 -4
  132. data/lib/comet/models/self_backup_target.rb +137 -0
  133. data/lib/comet/models/server_config_options.rb +253 -0
  134. data/lib/comet/models/server_config_options_branding_fragment.rb +2 -4
  135. data/lib/comet/models/server_config_options_software_build_role_fragment.rb +2 -4
  136. data/lib/comet/models/server_meta_branding_properties.rb +2 -4
  137. data/lib/comet/models/server_meta_version_info.rb +17 -4
  138. data/lib/comet/models/session_key_regenerated_response.rb +2 -4
  139. data/lib/comet/models/session_options.rb +73 -0
  140. data/lib/comet/models/sftpdestination_location.rb +2 -4
  141. data/lib/comet/models/size_measurement.rb +2 -4
  142. data/lib/comet/models/software_build_role_options.rb +2 -4
  143. data/lib/comet/models/software_update_news_response.rb +2 -4
  144. data/lib/comet/models/source_basic_info.rb +2 -4
  145. data/lib/comet/models/source_config.rb +2 -4
  146. data/lib/comet/models/source_include_pattern.rb +2 -4
  147. data/lib/comet/models/source_statistics.rb +2 -4
  148. data/lib/comet/models/spanned_destination_location.rb +2 -4
  149. data/lib/comet/models/spanned_storage_extra_info.rb +2 -4
  150. data/lib/comet/models/sshconnection.rb +2 -4
  151. data/lib/comet/models/stat_result.rb +2 -4
  152. data/lib/comet/models/storage_free_space_info.rb +2 -4
  153. data/lib/comet/models/storage_role_options.rb +110 -0
  154. data/lib/comet/models/storage_vault_provider_policy.rb +2 -4
  155. data/lib/comet/models/stored_object.rb +2 -4
  156. data/lib/comet/models/streamable_event.rb +2 -4
  157. data/lib/comet/models/swift_destination_location.rb +2 -4
  158. data/lib/comet/models/test_response.rb +2 -4
  159. data/lib/comet/models/totp_regenerated_response.rb +2 -4
  160. data/lib/comet/models/u2fregister_request.rb +2 -4
  161. data/lib/comet/models/u2fregistered_key.rb +2 -4
  162. data/lib/comet/models/u2fregistration_challenge_response.rb +2 -4
  163. data/lib/comet/models/u2fsign_request.rb +2 -4
  164. data/lib/comet/models/u2fsign_response.rb +2 -4
  165. data/lib/comet/models/uninstall_config.rb +2 -4
  166. data/lib/comet/models/update_campaign_device_status.rb +2 -4
  167. data/lib/comet/models/update_campaign_options.rb +5 -6
  168. data/lib/comet/models/update_campaign_properties.rb +2 -4
  169. data/lib/comet/models/update_campaign_status.rb +2 -4
  170. data/lib/comet/models/update_campaign_status_device_entry.rb +2 -4
  171. data/lib/comet/models/user_custom_email_settings.rb +2 -4
  172. data/lib/comet/models/user_on_server.rb +2 -4
  173. data/lib/comet/models/user_policy.rb +13 -4
  174. data/lib/comet/models/user_profile_config.rb +16 -8
  175. data/lib/comet/models/user_profile_fragment.rb +2 -4
  176. data/lib/comet/models/user_server_config.rb +75 -0
  177. data/lib/comet/models/vault_snapshot.rb +2 -4
  178. data/lib/comet/models/vmdksnapshot_view_options.rb +2 -4
  179. data/lib/comet/models/vsscomponent.rb +2 -4
  180. data/lib/comet/models/vsswriter_info.rb +2 -4
  181. data/lib/comet/models/wasabi_virtual_storage_role_settings.rb +2 -4
  182. data/lib/comet/models/web_authn_authenticator_selection.rb +2 -4
  183. data/lib/comet/models/web_authn_credential.rb +2 -4
  184. data/lib/comet/models/web_authn_credential_assertion.rb +2 -4
  185. data/lib/comet/models/web_authn_credential_descriptor.rb +2 -4
  186. data/lib/comet/models/web_authn_credential_entity.rb +2 -4
  187. data/lib/comet/models/web_authn_credential_parameter.rb +2 -4
  188. data/lib/comet/models/web_authn_public_key_credential_creation_options.rb +2 -4
  189. data/lib/comet/models/web_authn_public_key_credential_request_options.rb +2 -4
  190. data/lib/comet/models/web_authn_registration_challenge_response.rb +2 -4
  191. data/lib/comet/models/web_authn_relying_party_entity.rb +2 -4
  192. data/lib/comet/models/web_authn_sign_request.rb +2 -4
  193. data/lib/comet/models/web_authn_sign_response.rb +2 -4
  194. data/lib/comet/models/web_authn_user_entity.rb +2 -4
  195. data/lib/comet/models/web_interface_branding_properties.rb +2 -4
  196. data/lib/comet/models/webhook_option.rb +2 -4
  197. data/lib/comet/models/win_smbauth.rb +2 -4
  198. data/lib/comet/models/windows_code_sign_properties.rb +2 -4
  199. data/lib/comet_backup_ruby_sdk.rb +23 -4
  200. metadata +19 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 856c001592ef3dad994ed3d321f8fa68e9f01829770a33117f688a4d22312801
4
- data.tar.gz: b31ac9bbebfd4b3696d079b15ede4fcab8c7a927e087f84651861714a38a8172
3
+ metadata.gz: 33d616b7c183fa410f27c19bba61475b24ff0ba5e87b1adcf6354201ee645f3a
4
+ data.tar.gz: 5bbe3a08fc8552d36c9f379e9cdd80d6c31209741e940689651e443e75e2200d
5
5
  SHA512:
6
- metadata.gz: 1cf63478b5051ef36b844cbc82c8f20344e27a12e73898aec44e7f31f09a1cbd07e9d17ab58c0d1685de10716467d4643d90662208a331c0a3ec99eb0c96cfa2
7
- data.tar.gz: ee74bad01ce9338fa8536c02a38a66e9d8838b1dfe5560b1180163f978a81a75a8c438b885a95f6c4049d15cf26908ca60146b9b51689da4e5ef12f18454c24b
6
+ metadata.gz: 0d9400f4930b380cf561e95794a8c30f69eb777869bf6f629aef06bde55f834874f16857373ced01361f9d5239f4458fddf456ae2dfcb756efb0e10211e2850e
7
+ data.tar.gz: 4da36cb9d8d7896d8e09e1ccea1fca428cf43644521e01656df505257b5cbbdf60da44456ececb9e17172fef56f2328850ed9ef8e977ea5f629a0702a5dde798
data/.gitignore CHANGED
File without changes
data/.rubocop.yml CHANGED
File without changes
data/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 2022-09-08 v2.2.0
4
+ - Based on 22.9.0
5
+ - Add Storj.io support as a Storage Vault Location and Storage Template provider
6
+ - Add Constellation role support for Tenants
7
+ - Add Webhook edit option for Tenant admins
8
+ - Add MySQL direct RestoreType
9
+ - Improve Office365 credentials handling
10
+
11
+ ## 2022-07-27 v2.1.0
12
+ - Based on 22.6.7
13
+ - Add support enforcing the `RandomDelaySecs` for both whole-server and in policies
14
+ - Add support for username filter parameter in `AdminDispatcherListActive`
15
+ - Add custom region parameters for S3-compatible storage
16
+ - Add IDrive e2 as a Storage Template provider and in Constellation, including access-key cleanup
17
+ - Add `OverwriteIfNewer` to `RestoreJobAdvancedOptions`
18
+ - Add Office365 User Principal names
19
+
20
+ ## 2022-06-28 v2.0.0
21
+ - Based on 22.6.2
22
+ - **BREAKING:** The `Organization.Email` class member is now declared as `EmailOptions` type instead of `AdminEmailOptions`. This change is fully backward-compatible on the HTTP/JSON level, but may cause issues if your application code checked this type explicitly
23
+ - **BREAKING:** The `AdminOrganizationDeleteRequest` API's response type has changed to be `APIResponseMessage`, not `OrganizationResponse`. The Comet Server API had only ever filled in the `APIResponseMessage`-compatible fields of the `OrganizationResponse` structure, so the HTTP/JSON response is unchanged, but this may cause issues if your application code checked this type explicitly
24
+ - Move `frozen_string_literal` declaration to the top line of all `*.rb` files
25
+ - "Requestable" Storage Vaults have been renamed to "Storage Templates". The API endpoint is unchanged, so this is backward-compatible with older Comet Server instances
26
+ - Document all `ServerConfigOptions` types for the `AdminMetaServerConfigSet` and `AdminMetaServerConfigGet` APIs
27
+ - Add new `FallbackServers` option for LDAP external authentication sources
28
+ - Add new `RandomDelaySecs` option for job schedules
29
+
3
30
  ## 2022-06-03 v1.15.0
4
31
  - Based on 22.5.0
5
32
  - Add `COMPRESS_*` compression settings for Self-Backups
@@ -9,7 +36,7 @@
9
36
  ## 2022-05-25 v1.14.0
10
37
  - Based on 22.3.7
11
38
  - Add new `REMOTESERVER_S3_GENERIC` `RemoteServerType`
12
- - add new `S3GenericVirtualStorageRole` support to the `RemoteServerAddress`
39
+ - Add new `S3GenericVirtualStorageRole` support to the `RemoteServerAddress`
13
40
 
14
41
  ## 2022-05-10 v1.13.0
15
42
  - Based on 22.3.5
data/Gemfile CHANGED
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  source 'https://rubygems.org'
11
9
 
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- comet_backup_ruby_sdk (1.14.0)
4
+ comet_backup_ruby_sdk (2.2.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
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'rake/testtask'
11
9
  require 'rubocop/rake_task'
@@ -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 = '1.15.0'
15
+ spec.version = '2.2.0'
16
16
  spec.authors = ['Comet Licensing Ltd.']
17
17
  spec.email = ['hello@cometbackup.com']
18
18
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  module Comet
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'net/http'
11
9
  require 'json'
@@ -201,9 +199,9 @@ module Comet
201
199
  # @param [String] u2fclient_data U2F response data supplied by hardware token
202
200
  # @param [String] u2fregistration_data U2F response data supplied by hardware token
203
201
  # @param [String] u2fversion U2F response data supplied by hardware token
204
- # @param [String] description Optional description of the token
202
+ # @param [String] description (Optional) Description of the token
205
203
  # @return [Comet::CometAPIResponseMessage]
206
- def admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description)
204
+ def admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description = nil)
207
205
  submit_params = {}
208
206
  raise TypeError, "'u2fchallenge_id' expected String, got #{u2fchallenge_id.class}" unless u2fchallenge_id.is_a? String
209
207
 
@@ -217,9 +215,11 @@ module Comet
217
215
  raise TypeError, "'u2fversion' expected String, got #{u2fversion.class}" unless u2fversion.is_a? String
218
216
 
219
217
  submit_params['U2FVersion'] = u2fversion
220
- raise TypeError, "'description' expected String, got #{description.class}" unless description.is_a? String
218
+ unless description.nil?
219
+ raise TypeError, "'description' expected String, got #{description.class}" unless description.is_a? String
221
220
 
222
- submit_params['Description'] = description
221
+ submit_params['Description'] = description
222
+ end
223
223
 
224
224
  body = perform_request('api/v1/admin/account/u2f/submit-challenge-response', submit_params)
225
225
  json_body = JSON.parse body
@@ -817,7 +817,6 @@ module Comet
817
817
  # Get Constellation bucket usage report (cached).
818
818
  #
819
819
  # You must supply administrator authentication credentials to use this API.
820
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
821
820
  # This API requires the Constellation Role to be enabled.
822
821
  #
823
822
  # @return [Comet::ConstellationCheckReport]
@@ -835,7 +834,6 @@ module Comet
835
834
  # Get Constellation bucket usage report (regenerate).
836
835
  #
837
836
  # You must supply administrator authentication credentials to use this API.
838
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
839
837
  # This API requires the Constellation Role to be enabled.
840
838
  #
841
839
  # @return [Comet::ConstellationCheckReport]
@@ -871,7 +869,6 @@ module Comet
871
869
  # Get Constellation status.
872
870
  #
873
871
  # You must supply administrator authentication credentials to use this API.
874
- # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
875
872
  # This API requires the Constellation Role to be enabled.
876
873
  #
877
874
  # @return [Comet::ConstellationStatusAPIResponse]
@@ -1214,9 +1211,17 @@ module Comet
1214
1211
  # You must supply administrator authentication credentials to use this API.
1215
1212
  # This API requires the Auth Role to be enabled.
1216
1213
  #
1214
+ # @param [String] user_name_filter (Optional) User name filter string
1217
1215
  # @return [Hash{String => Comet::LiveUserConnection}]
1218
- def admin_dispatcher_list_active
1219
- body = perform_request('api/v1/admin/dispatcher/list-active')
1216
+ def admin_dispatcher_list_active(user_name_filter = nil)
1217
+ submit_params = {}
1218
+ unless user_name_filter.nil?
1219
+ raise TypeError, "'user_name_filter' expected String, got #{user_name_filter.class}" unless user_name_filter.is_a? String
1220
+
1221
+ submit_params['UserNameFilter'] = user_name_filter
1222
+ end
1223
+
1224
+ body = perform_request('api/v1/admin/dispatcher/list-active', submit_params)
1220
1225
  json_body = JSON.parse body
1221
1226
  check_status json_body
1222
1227
  ret = {}
@@ -2192,7 +2197,9 @@ module Comet
2192
2197
  #
2193
2198
  # This API will return all jobs that either started or ended within the supplied range.
2194
2199
  #
2195
- # Incomplete jobs have an end time of `0`. You can use this API to find incomplete jobs by setting both `Start` and `End` to `0`.
2200
+ # Incomplete jobs have an end time of `0`. You can use this API to find only incomplete jobs by setting both `Start` and `End` to `0`.
2201
+ #
2202
+ # Prior to Comet Server 22.6.0, additional Incomplete jobs may have been returned if you specified non-zero arguments for both `Start` and `End`.
2196
2203
  #
2197
2204
  # You must supply administrator authentication credentials to use this API.
2198
2205
  # This API requires the Auth Role to be enabled.
@@ -2513,6 +2520,46 @@ module Comet
2513
2520
  ret
2514
2521
  end
2515
2522
 
2523
+ # AdminMetaConstellationConfigGet
2524
+ #
2525
+ # Get Constellation configuration for the current organization.
2526
+ #
2527
+ # You must supply administrator authentication credentials to use this API.
2528
+ # This API requires the Constellation Role to be enabled.
2529
+ #
2530
+ # @return [Comet::ConstellationRoleOptions]
2531
+ def admin_meta_constellation_config_get
2532
+ body = perform_request('api/v1/admin/meta/constellation/config/get')
2533
+ json_body = JSON.parse body
2534
+ check_status json_body
2535
+ ret = Comet::ConstellationRoleOptions.new
2536
+ ret.from_hash(json_body)
2537
+ ret
2538
+ end
2539
+
2540
+ # AdminMetaConstellationConfigSet
2541
+ #
2542
+ # Set Constellation configuration for the current organization.
2543
+ #
2544
+ # You must supply administrator authentication credentials to use this API.
2545
+ # This API requires the Constellation Role to be enabled.
2546
+ #
2547
+ # @param [Comet::ConstellationRoleOptions] constellation_role_options Constellation role options to set
2548
+ # @return [Comet::CometAPIResponseMessage]
2549
+ def admin_meta_constellation_config_set(constellation_role_options)
2550
+ submit_params = {}
2551
+ raise TypeError, "'constellation_role_options' expected Comet::ConstellationRoleOptions, got #{constellation_role_options.class}" unless constellation_role_options.is_a? Comet::ConstellationRoleOptions
2552
+
2553
+ submit_params['ConstellationRoleOptions'] = constellation_role_options.to_json
2554
+
2555
+ body = perform_request('api/v1/admin/meta/constellation/config/set', submit_params)
2556
+ json_body = JSON.parse body
2557
+ check_status json_body
2558
+ ret = Comet::CometAPIResponseMessage.new
2559
+ ret.from_hash(json_body)
2560
+ ret
2561
+ end
2562
+
2516
2563
  # AdminMetaListAvailableLogDays
2517
2564
  #
2518
2565
  # Get log files.
@@ -2598,7 +2645,7 @@ module Comet
2598
2645
 
2599
2646
  # AdminMetaRemoteStorageVaultSet
2600
2647
  #
2601
- # Set Requestable Remote Storage Vault options.
2648
+ # Set Storage template vault options.
2602
2649
  #
2603
2650
  # You must supply administrator authentication credentials to use this API.
2604
2651
  # Access to this API may be prevented on a per-administrator basis.
@@ -2986,12 +3033,14 @@ module Comet
2986
3033
  #
2987
3034
  # Delete an organization and all related users.
2988
3035
  #
3036
+ # Prior to Comet 22.6.0, this API was documented as returning the OrganizationResponse type. However, it always has returned only a CometAPIResponseMessage.
3037
+ #
2989
3038
  # You must supply administrator authentication credentials to use this API.
2990
3039
  # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
2991
3040
  #
2992
3041
  # @param [String] organization_id (Optional) (No description available)
2993
3042
  # @param [Comet::UninstallConfig] uninstall_config (Optional) Uninstall software configuration
2994
- # @return [Comet::OrganizationResponse]
3043
+ # @return [Comet::CometAPIResponseMessage]
2995
3044
  def admin_organization_delete(organization_id = nil, uninstall_config = nil)
2996
3045
  submit_params = {}
2997
3046
  unless organization_id.nil?
@@ -3008,7 +3057,7 @@ module Comet
3008
3057
  body = perform_request('api/v1/admin/organization/delete', submit_params)
3009
3058
  json_body = JSON.parse body
3010
3059
  check_status json_body
3011
- ret = Comet::OrganizationResponse.new
3060
+ ret = Comet::CometAPIResponseMessage.new
3012
3061
  ret.from_hash(json_body)
3013
3062
  ret
3014
3063
  end
@@ -3041,6 +3090,8 @@ module Comet
3041
3090
  #
3042
3091
  # Create or Update an Organization.
3043
3092
  #
3093
+ # Prior to Comet 22.6.0, the 'ID' and 'Organization' fields were not present in the response.
3094
+ #
3044
3095
  # You must supply administrator authentication credentials to use this API.
3045
3096
  # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
3046
3097
  #
@@ -3308,7 +3359,7 @@ module Comet
3308
3359
  # This API requires the Auth Role to be enabled.
3309
3360
  #
3310
3361
  # @param [String] target_user The user to receive the new Storage Vault
3311
- # @param [String] storage_provider ID for the Requestable destination
3362
+ # @param [String] storage_provider ID for the storage template destination
3312
3363
  # @param [String] self_address (Optional) The external URL for this server. Used to resolve conflicts
3313
3364
  # @return [Comet::RequestStorageVaultResponseMessage]
3314
3365
  def admin_request_storage_vault(target_user, storage_provider, self_address = nil)
@@ -3342,7 +3393,7 @@ module Comet
3342
3393
  # You must supply administrator authentication credentials to use this API.
3343
3394
  # This API requires the Auth Role to be enabled.
3344
3395
  #
3345
- # @param [String] target_organization (Optional) If present, list the requestable Storage Vault options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)
3396
+ # @param [String] target_organization (Optional) If present, list the storage template options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)
3346
3397
  # @return [Hash{String => String}]
3347
3398
  def admin_request_storage_vault_providers(target_organization = nil)
3348
3399
  submit_params = {}
@@ -3378,9 +3429,9 @@ module Comet
3378
3429
  #
3379
3430
  # @param [String] target_user Selected account username
3380
3431
  # @param [String] new_password New account password
3381
- # @param [String] old_password Old account password (optional)
3432
+ # @param [String] old_password (Optional) Old account password. Required if no recovery code is present for the user account.
3382
3433
  # @return [Comet::CometAPIResponseMessage]
3383
- def admin_reset_user_password(target_user, new_password, old_password)
3434
+ def admin_reset_user_password(target_user, new_password, old_password = nil)
3384
3435
  submit_params = {}
3385
3436
  raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
3386
3437
 
@@ -3388,9 +3439,11 @@ module Comet
3388
3439
  raise TypeError, "'new_password' expected String, got #{new_password.class}" unless new_password.is_a? String
3389
3440
 
3390
3441
  submit_params['NewPassword'] = new_password
3391
- raise TypeError, "'old_password' expected String, got #{old_password.class}" unless old_password.is_a? String
3442
+ unless old_password.nil?
3443
+ raise TypeError, "'old_password' expected String, got #{old_password.class}" unless old_password.is_a? String
3392
3444
 
3393
- submit_params['OldPassword'] = old_password
3445
+ submit_params['OldPassword'] = old_password
3446
+ end
3394
3447
 
3395
3448
  body = perform_request('api/v1/admin/reset-user-password', submit_params)
3396
3449
  json_body = JSON.parse body
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  module Comet
11
9
 
@@ -137,6 +135,8 @@ module Comet
137
135
 
138
136
  DESTINATIONTYPE_B2 = 1008
139
137
 
138
+ DESTINATIONTYPE_STORJ = 1009
139
+
140
140
  DESTINATIONTYPE_LATEST = 1100
141
141
 
142
142
  DESTINATIONTYPE_ALL = 1101
@@ -220,6 +220,9 @@ module Comet
220
220
  # RestoreType:
221
221
  RESTORETYPE_VMDK_FILE_ARCHIVE = 9
222
222
 
223
+ # RestoreType:
224
+ RESTORETYPE_MYSQL = 10
225
+
223
226
  # RestoreType: RESTORETYPE_PROCESS_ARCHIVE
224
227
  RESTORETYPE_PROCESS_TARBALL = 3
225
228
 
@@ -322,6 +325,9 @@ module Comet
322
325
 
323
326
  SCHEDULE_FREQUENCY_HIGHEST = 8015
324
327
 
328
+ # Maximum random delay (5 hours)
329
+ SCHEDULE_MAX_RANDOM_DELAY_SECS = 18_000
330
+
325
331
  # 2^50 (1 << 50)
326
332
  SCHEDULE_MAXINT = 1_125_899_906_842_624
327
333
 
@@ -468,15 +474,15 @@ module Comet
468
474
 
469
475
  DEFAULT_TIMEZONE = 'UTC'
470
476
 
471
- APPLICATION_VERSION = '22.5.0'
477
+ APPLICATION_VERSION = '22.9.0'
472
478
 
473
479
  APPLICATION_VERSION_MAJOR = 22
474
480
 
475
- APPLICATION_VERSION_MINOR = 5
481
+ APPLICATION_VERSION_MINOR = 9
476
482
 
477
483
  APPLICATION_VERSION_REVISION = 0
478
484
 
479
- RELEASE_CODENAME = 'Lysithea'
485
+ RELEASE_CODENAME = 'Voyager'
480
486
 
481
487
  ENCRYPTIONMETHOD_UNCONFIGURED = 0
482
488
 
@@ -661,10 +667,19 @@ module Comet
661
667
  # RemoteServerType:
662
668
  REMOTESERVER_AWS = 'aws'
663
669
 
670
+ # RemoteServerType:
671
+ REMOTESERVER_STORJ = 'storj'
672
+
673
+ # RemoteServerType:
674
+ REMOTESERVER_IDRIVEE2 = 'idrivee2'
675
+
676
+ # LDAPSecurityMethod:
664
677
  LDAPSECURITYMETHOD_PLAIN = 'plain'
665
678
 
679
+ # LDAPSecurityMethod:
666
680
  LDAPSECURITYMETHOD_LDAPS = 'ldaps'
667
681
 
682
+ # LDAPSecurityMethod:
668
683
  LDAPSECURITYMETHOD_STARTTLS = 'starttls'
669
684
 
670
685
  # MacOSCodesignLevel:
@@ -676,6 +691,12 @@ module Comet
676
691
  # MacOSCodesignLevel:
677
692
  MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
678
693
 
694
+ # ClientBrandingBuildMode: Public-Doc: The software client will be custom-built by this Comet Server, allowing custom branding, default server URL, and codesigning.
695
+ CLIENTBRANDINGBUILD_CUSTOM = 0
696
+
697
+ # ClientBrandingBuildMode: Public-Doc: A pre-built software client will be served, with Comet-branding, no server URL, and Comet codesigning.
698
+ CLIENTBRANDINGBUILD_PREBUILT = 1
699
+
679
700
  # StreamableEventType:
680
701
  SEVT__MIN = 4000
681
702
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'base64'
11
9
  require 'json'
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -29,6 +27,12 @@ module Comet
29
27
  # @type [Boolean] allow_edit_remote_storage
30
28
  attr_accessor :allow_edit_remote_storage
31
29
 
30
+ # @type [Boolean] allow_edit_webhooks
31
+ attr_accessor :allow_edit_webhooks
32
+
33
+ # @type [Boolean] deny_constellation_role
34
+ attr_accessor :deny_constellation_role
35
+
32
36
  # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
33
37
  attr_accessor :unknown_json_fields
34
38
 
@@ -63,6 +67,10 @@ module Comet
63
67
  @allow_edit_branding = v
64
68
  when 'AllowEditRemoteStorage'
65
69
  @allow_edit_remote_storage = v
70
+ when 'AllowEditWebhooks'
71
+ @allow_edit_webhooks = v
72
+ when 'DenyConstellationRole'
73
+ @deny_constellation_role = v
66
74
  else
67
75
  @unknown_json_fields[k] = v
68
76
  end
@@ -87,6 +95,12 @@ module Comet
87
95
  unless @allow_edit_remote_storage.nil?
88
96
  ret['AllowEditRemoteStorage'] = @allow_edit_remote_storage
89
97
  end
98
+ unless @allow_edit_webhooks.nil?
99
+ ret['AllowEditWebhooks'] = @allow_edit_webhooks
100
+ end
101
+ unless @deny_constellation_role.nil?
102
+ ret['DenyConstellationRole'] = @deny_constellation_role
103
+ end
90
104
  @unknown_json_fields.each do |k, v|
91
105
  ret[k] = v
92
106
  end
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'base64'
11
9
  require 'json'
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9
 
@@ -1,11 +1,9 @@
1
- #!/usr/bin/env ruby --enable-frozen-string-literal
2
- #
1
+ # frozen_string_literal: true
2
+
3
3
  # Copyright (c) 2020-2022 Comet Licensing Ltd.
4
4
  # Please see the LICENSE file for usage information.
5
5
  #
6
6
  # SPDX-License-Identifier: MIT
7
- #
8
- # frozen_string_literal: true
9
7
 
10
8
  require 'json'
11
9