comet_backup_ruby_sdk 0.2.0

data/lib/comet/models/backup_rule_config.rb

@@ -0,0 +1,188 @@
+#!/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
+
+  # BackupRuleConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupRuleConfig
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [Number] create_time
+    attr_accessor :create_time
+
+    # @type [Number] modify_time
+    attr_accessor :modify_time
+
+    # @type [Array<String>] pre_exec
+    attr_accessor :pre_exec
+
+    # @type [Array<String>] post_exec
+    attr_accessor :post_exec
+
+    # @type [String] source
+    attr_accessor :source
+
+    # @type [String] destination
+    attr_accessor :destination
+
+    # @type [Boolean] skip_already_running
+    attr_accessor :skip_already_running
+
+    # @type [Number] stop_after
+    attr_accessor :stop_after
+
+    # @type [Number] limit_vault_speed_bps
+    attr_accessor :limit_vault_speed_bps
+
+    # @type [Boolean] reduce_disk_concurrency
+    attr_accessor :reduce_disk_concurrency
+
+    # @type [Boolean] use_on_disk_indexes
+    attr_accessor :use_on_disk_indexes
+
+    # @type [Boolean] allow_zero_files_success
+    attr_accessor :allow_zero_files_success
+
+    # @type [Array<Comet::ScheduleConfig>] schedules
+    attr_accessor :schedules
+
+    # @type [Comet::BackupRuleEventTriggers] event_triggers
+    attr_accessor :event_triggers
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @pre_exec = []
+      @post_exec = []
+      @schedules = []
+      @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 'Description'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @description = v
+        when 'CreateTime'
+          @create_time = v
+        when 'ModifyTime'
+          @modify_time = v
+        when 'PreExec'
+          if v.nil?
+            @pre_exec = []
+          else
+            @pre_exec = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError 'expected string' unless v1.is_a? String
+
+              @pre_exec[i1] = v1
+            end
+          end
+        when 'PostExec'
+          if v.nil?
+            @post_exec = []
+          else
+            @post_exec = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError 'expected string' unless v1.is_a? String
+
+              @post_exec[i1] = v1
+            end
+          end
+        when 'Source'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @source = v
+        when 'Destination'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @destination = v
+        when 'SkipAlreadyRunning'
+          @skip_already_running = v
+        when 'StopAfter'
+          @stop_after = v
+        when 'LimitVaultSpeedBps'
+          @limit_vault_speed_bps = v
+        when 'ReduceDiskConcurrency'
+          @reduce_disk_concurrency = v
+        when 'UseOnDiskIndexes'
+          @use_on_disk_indexes = v
+        when 'AllowZeroFilesSuccess'
+          @allow_zero_files_success = v
+        when 'Schedules'
+          if v.nil?
+            @schedules = []
+          else
+            @schedules = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @schedules[i1] = Comet::ScheduleConfig.new
+              @schedules[i1].from_hash(v1)
+            end
+          end
+        when 'EventTriggers'
+          @event_triggers = Comet::BackupRuleEventTriggers.new
+          @event_triggers.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['Description'] = @description
+      ret['CreateTime'] = @create_time
+      ret['ModifyTime'] = @modify_time
+      ret['PreExec'] = @pre_exec
+      ret['PostExec'] = @post_exec
+      ret['Source'] = @source
+      ret['Destination'] = @destination
+      ret['SkipAlreadyRunning'] = @skip_already_running
+      ret['StopAfter'] = @stop_after
+      ret['LimitVaultSpeedBps'] = @limit_vault_speed_bps
+      ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
+      ret['UseOnDiskIndexes'] = @use_on_disk_indexes
+      ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
+      ret['Schedules'] = @schedules
+      ret['EventTriggers'] = @event_triggers
+      @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/backup_rule_event_triggers.rb

@@ -0,0 +1,78 @@
+#!/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
+
+  # BackupRuleEventTriggers is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupRuleEventTriggers
+
+    # @type [Boolean] on_pcboot
+    attr_accessor :on_pcboot
+
+    # @type [Boolean] on_pcboot_if_last_job_missed
+    attr_accessor :on_pcboot_if_last_job_missed
+
+    # @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 'OnPCBoot'
+          @on_pcboot = v
+        when 'OnPCBootIfLastJobMissed'
+          @on_pcboot_if_last_job_missed = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @on_pcboot.nil?
+        ret['OnPCBoot'] = @on_pcboot
+      end
+      unless @on_pcboot_if_last_job_missed.nil?
+        ret['OnPCBootIfLastJobMissed'] = @on_pcboot_if_last_job_missed
+      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/branding_options.rb

@@ -0,0 +1,283 @@
+#!/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
+
+  # BrandingOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrandingOptions
+
+    # @type [String] brand_name
+    attr_accessor :brand_name
+
+    # @type [String] logo_image
+    attr_accessor :logo_image
+
+    # @type [String] top_color
+    attr_accessor :top_color
+
+    # @type [String] favicon
+    attr_accessor :favicon
+
+    # @type [Boolean] hide_news_area
+    attr_accessor :hide_news_area
+
+    # @type [String] product_name
+    attr_accessor :product_name
+
+    # @type [String] company_name
+    attr_accessor :company_name
+
+    # @type [String] help_url
+    attr_accessor :help_url
+
+    # @type [Boolean] help_is_popup
+    attr_accessor :help_is_popup
+
+    # @type [String] default_login_server_url
+    attr_accessor :default_login_server_url
+
+    # @type [String] tile_background_color
+    attr_accessor :tile_background_color
+
+    # @type [String] account_register_url
+    attr_accessor :account_register_url
+
+    # @type [Boolean] hide_background_logo
+    attr_accessor :hide_background_logo
+
+    # @type [String] path_ico_file
+    attr_accessor :path_ico_file
+
+    # @type [String] path_icns_file
+    attr_accessor :path_icns_file
+
+    # @type [String] path_eula_rtf
+    attr_accessor :path_eula_rtf
+
+    # @type [String] path_tile_png
+    attr_accessor :path_tile_png
+
+    # @type [String] path_header_image
+    attr_accessor :path_header_image
+
+    # @type [String] package_identifier
+    attr_accessor :package_identifier
+
+    # @type [String] windows_code_sign_pkcs12file_path
+    attr_accessor :windows_code_sign_pkcs12file_path
+
+    # @type [Number] windows_code_sign_pkcs12password_format
+    attr_accessor :windows_code_sign_pkcs12password_format
+
+    # @type [String] windows_code_sign_pkcs12password
+    attr_accessor :windows_code_sign_pkcs12password
+
+    # @type [String] windows_code_sign_pkcs11engine
+    attr_accessor :windows_code_sign_pkcs11engine
+
+    # @type [String] windows_code_sign_pkcs11module
+    attr_accessor :windows_code_sign_pkcs11module
+
+    # @type [String] windows_code_sign_pkcs11certfile
+    attr_accessor :windows_code_sign_pkcs11certfile
+
+    # @type [String] windows_code_sign_pkcs11key_id
+    attr_accessor :windows_code_sign_pkcs11key_id
+
+    # @type [Number] windows_code_sign_pkcs11password_format
+    attr_accessor :windows_code_sign_pkcs11password_format
+
+    # @type [String] windows_code_sign_pkcs11password
+    attr_accessor :windows_code_sign_pkcs11password
+
+    # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
+    attr_accessor :mac_oscode_sign
+
+    # @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 'BrandName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @brand_name = v
+        when 'LogoImage'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @logo_image = v
+        when 'TopColor'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @top_color = v
+        when 'Favicon'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @favicon = v
+        when 'HideNewsArea'
+          @hide_news_area = v
+        when 'ProductName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @product_name = v
+        when 'CompanyName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @company_name = v
+        when 'HelpURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @help_url = v
+        when 'HelpIsPopup'
+          @help_is_popup = v
+        when 'DefaultLoginServerURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @default_login_server_url = v
+        when 'TileBackgroundColor'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @tile_background_color = v
+        when 'AccountRegisterURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @account_register_url = v
+        when 'HideBackgroundLogo'
+          @hide_background_logo = v
+        when 'PathIcoFile'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @path_ico_file = v
+        when 'PathIcnsFile'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @path_icns_file = v
+        when 'PathEulaRtf'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @path_eula_rtf = v
+        when 'PathTilePng'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @path_tile_png = v
+        when 'PathHeaderImage'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @path_header_image = v
+        when 'PackageIdentifier'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @package_identifier = v
+        when 'WindowsCodeSignPKCS12FilePath'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs12file_path = v
+        when 'WindowsCodeSignPKCS12PasswordFormat'
+          @windows_code_sign_pkcs12password_format = v
+        when 'WindowsCodeSignPKCS12Password'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs12password = v
+        when 'WindowsCodeSignPKCS11Engine'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs11engine = v
+        when 'WindowsCodeSignPKCS11Module'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs11module = v
+        when 'WindowsCodeSignPKCS11Certfile'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs11certfile = v
+        when 'WindowsCodeSignPKCS11KeyID'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs11key_id = v
+        when 'WindowsCodeSignPKCS11PasswordFormat'
+          @windows_code_sign_pkcs11password_format = v
+        when 'WindowsCodeSignPKCS11Password'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @windows_code_sign_pkcs11password = v
+        when 'MacOSCodeSign'
+          @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
+          @mac_oscode_sign.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['BrandName'] = @brand_name
+      ret['LogoImage'] = @logo_image
+      ret['TopColor'] = @top_color
+      ret['Favicon'] = @favicon
+      ret['HideNewsArea'] = @hide_news_area
+      ret['ProductName'] = @product_name
+      ret['CompanyName'] = @company_name
+      ret['HelpURL'] = @help_url
+      ret['HelpIsPopup'] = @help_is_popup
+      ret['DefaultLoginServerURL'] = @default_login_server_url
+      ret['TileBackgroundColor'] = @tile_background_color
+      ret['AccountRegisterURL'] = @account_register_url
+      ret['HideBackgroundLogo'] = @hide_background_logo
+      ret['PathIcoFile'] = @path_ico_file
+      ret['PathIcnsFile'] = @path_icns_file
+      ret['PathEulaRtf'] = @path_eula_rtf
+      ret['PathTilePng'] = @path_tile_png
+      ret['PathHeaderImage'] = @path_header_image
+      ret['PackageIdentifier'] = @package_identifier
+      ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
+      ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
+      ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
+      ret['WindowsCodeSignPKCS11Engine'] = @windows_code_sign_pkcs11engine
+      ret['WindowsCodeSignPKCS11Module'] = @windows_code_sign_pkcs11module
+      ret['WindowsCodeSignPKCS11Certfile'] = @windows_code_sign_pkcs11certfile
+      ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
+      ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
+      ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
+      ret['MacOSCodeSign'] = @mac_oscode_sign
+      @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