comet_backup_ruby_sdk 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e207ce3e89091839b912a7f7ee7de17315de2474890d7560b5b79f1afee434c5
-  data.tar.gz: d85eddeaa1e27a71d3d1415742afa28808e8575f2a46bf20d56a7b0da75a3c9f
+  metadata.gz: e7343bc96e2ac87ca1b4ff694fbe25e01c6cca99b8dfe6da063050ab3c462530
+  data.tar.gz: ce7ea45a2480321db18a7bc3758d742464810d8feb1c6e2a652df13365404c92
 SHA512:
-  metadata.gz: 566f2c136d8c7af458ab75d6fd9f0117ab68a5c114e1ab589af8990773f8e6850326d323380aec56a36332e6bfc85686ce5cbdafeeb358ccb5a0058a2d051e0e
-  data.tar.gz: c92c6256810c4dcaec62ee81ff44ebc2944b97c41a5fa193200b340f523973ea74fee4c4372d37321356020c9323723e7137d2b4593b8fc381ef00abcd96212c
+  metadata.gz: 420c4b3892475409d56b1cc64a6a90e9d06ad8dcc4ad7ec3550ad0b861a5ad14807b0f21f4c4bfa542ff010b6beb833a91e627195c8ba215badc7528f7861072
+  data.tar.gz: 19ff57505c136f8d4150987cdd05c7d2133f7541c30256b579b46d83ae373847ea6a1af86c5b2cf2f0f61d672eeb3cff806bd0795d1d27762375df13b371a5f4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 2021-07-01 v1.6.0
+- Based on Comet 21.6.6
+- Support new `DefaultSourceWithOSRestriction` and `LastSuccessfulBackupJob` fields
+- Support custom credentials when performing a cloud Office 365 restore job
+- Support identifying Microsoft Teams folders inside a Sharepoint backup job
+- Document the `SourceIncludePattern` structure used for `PINCLUDE`/`RINCLUDE` rules in a File-type `EngineProps` array
+- Document existing `BrandingProps` endpoint
+
 ## 2021-05-25 v1.5.0
 - Based on Comet 21.6.1
 - Add new APIs to remotely browse MySQL, MongoDB, MSSQL database servers

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.4.0)
+    comet_backup_ruby_sdk (1.6.0)
 
 GEM
   remote: https://rubygems.org/

data/RELEASING.md

@@ -2,9 +2,11 @@
 
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
-3. Update version number in `gemspec`
-4. `gem build comet_backup_ruby_sdk`
+3. Update version number in `comet_backup_ruby_sdk.gemspec`
+4. `bundle install`
+	- Should update our internal version in Gemfile.lock
+4. `gem build comet_backup_ruby_sdk.gemspec`
 	- Should be warning-free
 5. Git tag
 	- Respect semver
-6. `gem push comet_backup_ruby_sdk-0.x.x.gem`
+6. `gem push comet_backup_ruby_sdk-1.x.x.gem`

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '1.5.0'
+  spec.version       = '1.6.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/definitions.rb

@@ -353,6 +353,9 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITE = 'mssite'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITE_TEAM = 'mssiteteam'
+
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITELISTENTITY = 'mssitelistentity'
 
@@ -397,13 +400,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.6.1'
+  APPLICATION_VERSION = '21.6.6'
 
   APPLICATION_VERSION_MAJOR = 21
 
   APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 1
+  APPLICATION_VERSION_REVISION = 6
 
   RELEASE_CODENAME = 'Voyager'
 

data/lib/comet/models/default_source_with_osrestriction.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # DefaultSourceWithOSRestriction is a typed class wrapper around the underlying Comet Server API data structure.
+  class DefaultSourceWithOSRestriction
+
+    # @type [Comet::SourceConfig] source_config
+    attr_accessor :source_config
+
+    # @type [Number] restrict_os
+    attr_accessor :restrict_os
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @source_config = Comet::SourceConfig.new
+      @restrict_os = 0
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'SourceConfig'
+          @source_config = Comet::SourceConfig.new
+          @source_config.from_hash(v)
+        when 'RestrictOS'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @restrict_os = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SourceConfig'] = @source_config
+      ret['RestrictOS'] = @restrict_os
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -32,6 +32,9 @@ module Comet
     # @type [Number] archive_format
     attr_accessor :archive_format
 
+    # @type [Comet::Office365Credential] office_365credential
+    attr_accessor :office_365credential
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +47,7 @@ module Comet
       @dest_path = ''
       @exact_dest_paths = []
       @archive_format = 0
+      @office_365credential = Comet::Office365Credential.new
       @unknown_json_fields = {}
     end
 
@@ -87,6 +91,9 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @archive_format = v
+        when 'Office365Credential'
+          @office_365credential = Comet::Office365Credential.new
+          @office_365credential.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -102,6 +109,9 @@ module Comet
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths
       ret['ArchiveFormat'] = @archive_format
+      unless @office_365credential.nil?
+        ret['Office365Credential'] = @office_365credential
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/server_meta_branding_properties.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # ServerMetaBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
+  class ServerMetaBrandingProperties
+
+    # @type [String] brand_name
+    attr_accessor :brand_name
+
+    # @type [String] product_name
+    attr_accessor :product_name
+
+    # @type [Boolean] has_image
+    attr_accessor :has_image
+
+    # @type [String] top_color
+    attr_accessor :top_color
+
+    # @type [Boolean] hide_news_area
+    attr_accessor :hide_news_area
+
+    # @type [Boolean] allow_unauthenticated_downloads
+    attr_accessor :allow_unauthenticated_downloads
+
+    # @type [Boolean] allow_authenticated_downloads
+    attr_accessor :allow_authenticated_downloads
+
+    # @type [Number] prune_logs_after_days
+    attr_accessor :prune_logs_after_days
+
+    # @type [Number] expired_in_seconds
+    attr_accessor :expired_in_seconds
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @brand_name = ''
+      @product_name = ''
+      @top_color = ''
+      @prune_logs_after_days = 0
+      @expired_in_seconds = 0
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'BrandName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @brand_name = v
+        when 'ProductName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @product_name = v
+        when 'HasImage'
+          @has_image = v
+        when 'TopColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @top_color = v
+        when 'HideNewsArea'
+          @hide_news_area = v
+        when 'AllowUnauthenticatedDownloads'
+          @allow_unauthenticated_downloads = v
+        when 'AllowAuthenticatedDownloads'
+          @allow_authenticated_downloads = v
+        when 'PruneLogsAfterDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @prune_logs_after_days = v
+        when 'ExpiredInSeconds'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @expired_in_seconds = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['BrandName'] = @brand_name
+      ret['ProductName'] = @product_name
+      ret['HasImage'] = @has_image
+      ret['TopColor'] = @top_color
+      ret['HideNewsArea'] = @hide_news_area
+      ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
+      ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads
+      ret['PruneLogsAfterDays'] = @prune_logs_after_days
+      ret['ExpiredInSeconds'] = @expired_in_seconds
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/source_include_pattern.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # SourceIncludePattern is a typed class wrapper around the underlying Comet Server API data structure.
+  class SourceIncludePattern
+
+    # @type [String] top_directory
+    attr_accessor :top_directory
+
+    # @type [String] value
+    attr_accessor :value
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @top_directory = ''
+      @value = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'TopDirectory'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @top_directory = v
+        when 'Value'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @value = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['TopDirectory'] = @top_directory
+      ret['Value'] = @value
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/source_statistics.rb

@@ -17,6 +17,9 @@ module Comet
     # @type [Comet::BackupJobDetail] last_backup_job
     attr_accessor :last_backup_job
 
+    # @type [Comet::BackupJobDetail] last_successful_backup_job
+    attr_accessor :last_successful_backup_job
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -26,6 +29,7 @@ module Comet
 
     def clear
       @last_backup_job = Comet::BackupJobDetail.new
+      @last_successful_backup_job = Comet::BackupJobDetail.new
       @unknown_json_fields = {}
     end
 
@@ -45,6 +49,9 @@ module Comet
         when 'LastBackupJob'
           @last_backup_job = Comet::BackupJobDetail.new
           @last_backup_job.from_hash(v)
+        when 'LastSuccessfulBackupJob'
+          @last_successful_backup_job = Comet::BackupJobDetail.new
+          @last_successful_backup_job.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -55,6 +62,7 @@ module Comet
     def to_hash
       ret = {}
       ret['LastBackupJob'] = @last_backup_job
+      ret['LastSuccessfulBackupJob'] = @last_successful_backup_job
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/user_policy.rb

@@ -107,6 +107,9 @@ module Comet
     # @type [Hash{String => Comet::BackupRuleConfig}] default_sources_backup_rules
     attr_accessor :default_sources_backup_rules
 
+    # @type [Hash{String => Comet::DefaultSourceWithOSRestriction}] default_sources_with_osrestriction
+    attr_accessor :default_sources_with_osrestriction
+
     # @type [Hash{String => Comet::BackupRuleConfig}] default_backup_rules
     attr_accessor :default_backup_rules
 
@@ -129,6 +132,7 @@ module Comet
       @default_storage_vault_retention = Comet::RetentionPolicy.new
       @default_sources = {}
       @default_sources_backup_rules = {}
+      @default_sources_with_osrestriction = {}
       @default_backup_rules = {}
       @unknown_json_fields = {}
     end
@@ -244,6 +248,16 @@ module Comet
               @default_sources_backup_rules[k1].from_hash(v1)
             end
           end
+        when 'DefaultSourcesWithOSRestriction'
+          @default_sources_with_osrestriction = {}
+          if v.nil?
+            @default_sources_with_osrestriction = {}
+          else
+            v.each do |k1, v1|
+              @default_sources_with_osrestriction[k1] = Comet::DefaultSourceWithOSRestriction.new
+              @default_sources_with_osrestriction[k1].from_hash(v1)
+            end
+          end
         when 'DefaultBackupRules'
           @default_backup_rules = {}
           if v.nil?
@@ -304,6 +318,7 @@ module Comet
       ret['PreventProtectedItemRetention'] = @prevent_protected_item_retention
       ret['DefaultSources'] = @default_sources
       ret['DefaultSourcesBackupRules'] = @default_sources_backup_rules
+      ret['DefaultSourcesWithOSRestriction'] = @default_sources_with_osrestriction
       ret['DefaultBackupRules'] = @default_backup_rules
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet_backup_ruby_sdk.rb

@@ -48,6 +48,7 @@ require_relative 'comet/models/content_measurement_component'
 require_relative 'comet/models/create_group_policy_response'
 require_relative 'comet/models/custom_remote_bucket_settings'
 require_relative 'comet/models/default_email_report_policy'
+require_relative 'comet/models/default_source_with_osrestriction'
 require_relative 'comet/models/destination_config'
 require_relative 'comet/models/destination_location'
 require_relative 'comet/models/destination_statistics'
@@ -106,6 +107,7 @@ require_relative 'comet/models/search_clause'
 require_relative 'comet/models/self_backup_statistics'
 require_relative 'comet/models/server_config_options_branding_fragment'
 require_relative 'comet/models/server_config_options_software_build_role_fragment'
+require_relative 'comet/models/server_meta_branding_properties'
 require_relative 'comet/models/server_meta_version_info'
 require_relative 'comet/models/session_key_regenerated_response'
 require_relative 'comet/models/sftpdestination_location'
@@ -114,6 +116,7 @@ require_relative 'comet/models/software_build_role_options'
 require_relative 'comet/models/software_update_news_response'
 require_relative 'comet/models/source_basic_info'
 require_relative 'comet/models/source_config'
+require_relative 'comet/models/source_include_pattern'
 require_relative 'comet/models/source_statistics'
 require_relative 'comet/models/spanned_destination_location'
 require_relative 'comet/models/spanned_storage_extra_info'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - lib/comet/models/create_group_policy_response.rb
 - lib/comet/models/custom_remote_bucket_settings.rb
 - lib/comet/models/default_email_report_policy.rb
+- lib/comet/models/default_source_with_osrestriction.rb
 - lib/comet/models/destination_config.rb
 - lib/comet/models/destination_location.rb
 - lib/comet/models/destination_statistics.rb
@@ -181,6 +182,7 @@ files:
 - lib/comet/models/self_backup_statistics.rb
 - lib/comet/models/server_config_options_branding_fragment.rb
 - lib/comet/models/server_config_options_software_build_role_fragment.rb
+- lib/comet/models/server_meta_branding_properties.rb
 - lib/comet/models/server_meta_version_info.rb
 - lib/comet/models/session_key_regenerated_response.rb
 - lib/comet/models/sftpdestination_location.rb
@@ -189,6 +191,7 @@ files:
 - lib/comet/models/software_update_news_response.rb
 - lib/comet/models/source_basic_info.rb
 - lib/comet/models/source_config.rb
+- lib/comet/models/source_include_pattern.rb
 - lib/comet/models/source_statistics.rb
 - lib/comet/models/spanned_destination_location.rb
 - lib/comet/models/spanned_storage_extra_info.rb
@@ -230,7 +233,7 @@ homepage: https://github.com/CometBackup/comet-ruby-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Comet Backup - Comet Server API SDK
 test_files: []