comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/stat_result.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StatResult is a typed class wrapper around the underlying Comet Server API data structure.
+  class StatResult
+
+    # @type [Number] buckets
+    attr_accessor :buckets
+
+    # @type [Number] users
+    attr_accessor :users
+
+    # @type [Number] devices
+    attr_accessor :devices
+
+    # @type [Number] boosters
+    attr_accessor :boosters
+
+    # @type [Number] network_devices
+    attr_accessor :network_devices
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @buckets = 0
+      @users = 0
+      @devices = 0
+      @boosters = 0
+      @network_devices = 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 'Buckets'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @buckets = v
+        when 'Users'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @users = v
+        when 'Devices'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @devices = v
+        when 'Boosters'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @boosters = v
+        when 'NetworkDevices'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @network_devices = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Buckets'] = @buckets
+      ret['Users'] = @users
+      ret['Devices'] = @devices
+      ret['Boosters'] = @boosters
+      ret['NetworkDevices'] = @network_devices
+      @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/models/storage_free_space_info.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StorageFreeSpaceInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class StorageFreeSpaceInfo
+
+    # @type [Boolean] unlimited
+    attr_accessor :unlimited
+
+    # @type [Number] used_percent
+    attr_accessor :used_percent
+
+    # @type [Number] available_bytes
+    attr_accessor :available_bytes
+
+    # @type [Comet::SpannedStorageExtraInfo] spanned
+    attr_accessor :spanned
+
+    # @type [Comet::B2StorageExtraInfo] b2
+    attr_accessor :b2
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @used_percent = 0.0
+      @available_bytes = 0
+      @spanned = Comet::SpannedStorageExtraInfo.new
+      @b2 = Comet::B2StorageExtraInfo.new
+      @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 'Unlimited'
+          @unlimited = v
+        when 'UsedPercent'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @used_percent = v
+        when 'AvailableBytes'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @available_bytes = v
+        when 'Spanned'
+          @spanned = Comet::SpannedStorageExtraInfo.new
+          @spanned.from_hash(v)
+        when 'B2'
+          @b2 = Comet::B2StorageExtraInfo.new
+          @b2.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['Unlimited'] = @unlimited
+      ret['UsedPercent'] = @used_percent
+      ret['AvailableBytes'] = @available_bytes
+      unless @spanned.nil?
+        ret['Spanned'] = @spanned
+      end
+      unless @b2.nil?
+        ret['B2'] = @b2
+      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/models/storage_vault_provider_policy.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StorageVaultProviderPolicy is a typed class wrapper around the underlying Comet Server API data structure.
+  class StorageVaultProviderPolicy
+
+    # @type [Boolean] should_restrict_provider_list
+    attr_accessor :should_restrict_provider_list
+
+    # @type [Array<Number>] allowed_providers_when_restricted
+    attr_accessor :allowed_providers_when_restricted
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @allowed_providers_when_restricted = []
+      @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 'ShouldRestrictProviderList'
+          @should_restrict_provider_list = v
+        when 'AllowedProvidersWhenRestricted'
+          if v.nil?
+            @allowed_providers_when_restricted = []
+          else
+            @allowed_providers_when_restricted = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @allowed_providers_when_restricted[i1] = v1
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ShouldRestrictProviderList'] = @should_restrict_provider_list
+      ret['AllowedProvidersWhenRestricted'] = @allowed_providers_when_restricted
+      @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/models/stored_object.rb

@@ -0,0 +1,238 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StoredObject is a typed class wrapper around the underlying Comet Server API data structure.
+  class StoredObject
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Number] modify_time
+    attr_accessor :modify_time
+
+    # One of the STOREDOBJECTTYPE_... constant values
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] subtree
+    attr_accessor :subtree
+
+    # @type [Number] size
+    attr_accessor :size
+
+    # @type [String] display_name
+    attr_accessor :display_name
+
+    # @type [String] item_class
+    attr_accessor :item_class
+
+    # @type [String] from
+    attr_accessor :from
+
+    # @type [String] to
+    attr_accessor :to
+
+    # @type [Number] received_date_time
+    attr_accessor :received_date_time
+
+    # @type [Boolean] has_attachments
+    attr_accessor :has_attachments
+
+    # @type [Number] start_time
+    attr_accessor :start_time
+
+    # @type [Number] end_time
+    attr_accessor :end_time
+
+    # @type [Boolean] recursive_count_known
+    attr_accessor :recursive_count_known
+
+    # @type [Number] recursive_files
+    attr_accessor :recursive_files
+
+    # @type [Number] recursive_bytes
+    attr_accessor :recursive_bytes
+
+    # @type [Number] recursive_folders
+    attr_accessor :recursive_folders
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @name = ''
+      @modify_time = 0
+      @type = ''
+      @subtree = ''
+      @size = 0
+      @display_name = ''
+      @item_class = ''
+      @from = ''
+      @to = ''
+      @received_date_time = 0
+      @start_time = 0
+      @end_time = 0
+      @recursive_files = 0
+      @recursive_bytes = 0
+      @recursive_folders = 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 'name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'mtime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @modify_time = v
+        when 'type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'subtree'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @subtree = v
+        when 'size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        when 'dname'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @display_name = v
+        when 'itemClass'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @item_class = v
+        when 'from'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @from = v
+        when 'to'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @to = v
+        when 'rtime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @received_date_time = v
+        when 'has_attachments'
+          @has_attachments = v
+        when 'stime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @start_time = v
+        when 'etime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @end_time = v
+        when 'r'
+          @recursive_count_known = v
+        when 'f'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @recursive_files = v
+        when 'b'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @recursive_bytes = v
+        when 'd'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @recursive_folders = 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['mtime'] = @modify_time
+      ret['type'] = @type
+      ret['subtree'] = @subtree
+      ret['size'] = @size
+      unless @display_name.nil?
+        ret['dname'] = @display_name
+      end
+      unless @item_class.nil?
+        ret['itemClass'] = @item_class
+      end
+      unless @from.nil?
+        ret['from'] = @from
+      end
+      unless @to.nil?
+        ret['to'] = @to
+      end
+      unless @received_date_time.nil?
+        ret['rtime'] = @received_date_time
+      end
+      unless @has_attachments.nil?
+        ret['has_attachments'] = @has_attachments
+      end
+      unless @start_time.nil?
+        ret['stime'] = @start_time
+      end
+      unless @end_time.nil?
+        ret['etime'] = @end_time
+      end
+      unless @recursive_count_known.nil?
+        ret['r'] = @recursive_count_known
+      end
+      unless @recursive_files.nil?
+        ret['f'] = @recursive_files
+      end
+      unless @recursive_bytes.nil?
+        ret['b'] = @recursive_bytes
+      end
+      unless @recursive_folders.nil?
+        ret['d'] = @recursive_folders
+      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/models/streamable_event.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StreamableEvent is a typed class wrapper around the underlying Comet Server API data structure.
+  class StreamableEvent
+
+    # @type [String] owner_organization_id
+    attr_accessor :owner_organization_id
+
+    # @type [Number] type
+    attr_accessor :type
+
+    # @type [Object] data
+    attr_accessor :data
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @owner_organization_id = ''
+      @type = 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 'OwnerOrganizationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @owner_organization_id = v
+        when 'Type'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @type = v
+        when 'Data'
+          @data = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['OwnerOrganizationID'] = @owner_organization_id
+      ret['Type'] = @type
+      unless @data.nil?
+        ret['Data'] = @data
+      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