comet_backup_ruby_sdk 0.2.0

data/lib/comet/models/edbfile_info.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # EDBFileInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class EDBFileInfo
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [String] guid
+    attr_accessor :guid
+
+    # @type [String] server_name
+    attr_accessor :server_name
+
+    # @type [Boolean] circular_logging_enabled
+    attr_accessor :circular_logging_enabled
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Name'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @name = v
+        when 'Guid'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @guid = v
+        when 'ServerName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @server_name = v
+        when 'CircularLoggingEnabled'
+          @circular_logging_enabled = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Name'] = @name
+      ret['Guid'] = @guid
+      ret['ServerName'] = @server_name
+      ret['CircularLoggingEnabled'] = @circular_logging_enabled
+      @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/email_options.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # EmailOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class EmailOptions
+
+    # @type [String] mode
+    attr_accessor :mode
+
+    # @type [String] from_email
+    attr_accessor :from_email
+
+    # @type [String] from_name
+    attr_accessor :from_name
+
+    # @type [String] smtphost
+    attr_accessor :smtphost
+
+    # @type [Number] smtpport
+    attr_accessor :smtpport
+
+    # @type [String] smtpusername
+    attr_accessor :smtpusername
+
+    # @type [String] smtppassword
+    attr_accessor :smtppassword
+
+    # @type [Boolean] smtpallow_invalid_certificate
+    attr_accessor :smtpallow_invalid_certificate
+
+    # @type [Boolean] smtpallow_unencrypted
+    attr_accessor :smtpallow_unencrypted
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Mode'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @mode = v
+        when 'FromEmail'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @from_email = v
+        when 'FromName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @from_name = v
+        when 'SMTPHost'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @smtphost = v
+        when 'SMTPPort'
+          @smtpport = v
+        when 'SMTPUsername'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @smtpusername = v
+        when 'SMTPPassword'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @smtppassword = v
+        when 'SMTPAllowInvalidCertificate'
+          @smtpallow_invalid_certificate = v
+        when 'SMTPAllowUnencrypted'
+          @smtpallow_unencrypted = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Mode'] = @mode
+      ret['FromEmail'] = @from_email
+      ret['FromName'] = @from_name
+      unless @smtphost.nil?
+        ret['SMTPHost'] = @smtphost
+      end
+      unless @smtpport.nil?
+        ret['SMTPPort'] = @smtpport
+      end
+      unless @smtpusername.nil?
+        ret['SMTPUsername'] = @smtpusername
+      end
+      unless @smtppassword.nil?
+        ret['SMTPPassword'] = @smtppassword
+      end
+      unless @smtpallow_invalid_certificate.nil?
+        ret['SMTPAllowInvalidCertificate'] = @smtpallow_invalid_certificate
+      end
+      unless @smtpallow_unencrypted.nil?
+        ret['SMTPAllowUnencrypted'] = @smtpallow_unencrypted
+      end
+      @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/email_report_config.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # EmailReportConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class EmailReportConfig
+
+    # @type [Number] report_type
+    attr_accessor :report_type
+
+    # @type [Array<Comet::ScheduleConfig>] summary_frequency
+    attr_accessor :summary_frequency
+
+    # @type [Comet::SearchClause] filter
+    attr_accessor :filter
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @summary_frequency = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'ReportType'
+          @report_type = v
+        when 'SummaryFrequency'
+          if v.nil?
+            @summary_frequency = []
+          else
+            @summary_frequency = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @summary_frequency[i1] = Comet::ScheduleConfig.new
+              @summary_frequency[i1].from_hash(v1)
+            end
+          end
+        when 'Filter'
+          @filter = Comet::SearchClause.new
+          @filter.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ReportType'] = @report_type
+      ret['SummaryFrequency'] = @summary_frequency
+      ret['Filter'] = @filter
+      @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/email_report_generated_preview.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # EmailReportGeneratedPreview is a typed class wrapper around the underlying Comet Server API data structure.
+  class EmailReportGeneratedPreview
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] email_subject
+    attr_accessor :email_subject
+
+    # @type [String] email_body_html
+    attr_accessor :email_body_html
+
+    # @type [String] email_body_plaintext
+    attr_accessor :email_body_plaintext
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          @status = v
+        when 'Message'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @message = v
+        when 'EmailSubject'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @email_subject = v
+        when 'EmailBodyHTML'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @email_body_html = v
+        when 'EmailBodyPlaintext'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @email_body_plaintext = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['EmailSubject'] = @email_subject
+      ret['EmailBodyHTML'] = @email_body_html
+      ret['EmailBodyPlaintext'] = @email_body_plaintext
+      @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/extra_file_exclusion.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # ExtraFileExclusion is a typed class wrapper around the underlying Comet Server API data structure.
+  class ExtraFileExclusion
+
+    # @type [String] exclude
+    attr_accessor :exclude
+
+    # @type [Boolean] regex
+    attr_accessor :regex
+
+    # @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
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Exclude'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @exclude = v
+        when 'Regex'
+          @regex = v
+        when 'RestrictOS'
+          @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['Exclude'] = @exclude
+      ret['Regex'] = @regex
+      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