petstroepack 1.0.0

data/lib/ctd_documentation/models/assets_with_insights.rb

@@ -0,0 +1,252 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # AssetsWithInsights Model.
+  class AssetsWithInsights < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :resource_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :site_id
+
+    # The number represents the Asset type
+    # @return [Integer]
+    attr_accessor :asset_type
+
+    # The label of the Asset type
+    # @return [String]
+    attr_accessor :asset_type___name
+
+    # The number represent the Asset criticality
+    # @return [Integer]
+    attr_accessor :criticality
+
+    # The label of the Asset criticality
+    # @return [String]
+    attr_accessor :criticality___name
+
+    # The Asset firmware
+    # @return [String]
+    attr_accessor :firmware
+
+    # Asset who has only incoming communications, i.e. asset that never replied
+    # @return [TrueClass|FalseClass]
+    attr_accessor :ghost
+
+    # Asset who has only incoming communications, i.e. asset that never replied
+    # @return [List of SlimInsight]
+    attr_accessor :insights
+
+    # The IPv4 addresses related to the Asset
+    # @return [List of String]
+    attr_accessor :i_pv4
+
+    # The IPv6 addresses related to the Asset
+    # @return [List of String]
+    attr_accessor :i_pv6
+
+    # The MAC addresses that related to the Asset
+    # @return [List of String]
+    attr_accessor :mac
+
+    # The Asset's model
+    # @return [String]
+    attr_accessor :model
+
+    # The Asset's name
+    # @return [String]
+    attr_accessor :name
+
+    # The Asset's network ID number
+    # @return [Integer]
+    attr_accessor :network_id
+
+    # The level of the Asset's vulnerability to attacks
+    # @return [Integer]
+    attr_accessor :risk_level
+
+    # The name of the Site that the Asset is related to
+    # @return [String]
+    attr_accessor :site_name
+
+    # The total CVEs number that are related to the Asset
+    # @return [Integer]
+    attr_accessor :total_cves_count
+
+    # the Asset's vendor
+    # @return [String]
+    attr_accessor :vendor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resource_id'] = 'resource_id'
+      @_hash['id'] = 'id'
+      @_hash['site_id'] = 'site_id'
+      @_hash['asset_type'] = 'asset_type'
+      @_hash['asset_type___name'] = 'asset_type__(name)'
+      @_hash['criticality'] = 'criticality'
+      @_hash['criticality___name'] = 'criticality__(name)'
+      @_hash['firmware'] = 'firmware'
+      @_hash['ghost'] = 'ghost'
+      @_hash['insights'] = 'insights'
+      @_hash['i_pv4'] = 'IPv4'
+      @_hash['i_pv6'] = 'IPv6'
+      @_hash['mac'] = 'mac'
+      @_hash['model'] = 'model'
+      @_hash['name'] = 'name'
+      @_hash['network_id'] = 'network_id'
+      @_hash['risk_level'] = 'risk_level'
+      @_hash['site_name'] = 'site_name'
+      @_hash['total_cves_count'] = 'total_cves_count'
+      @_hash['vendor'] = 'vendor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resource_id
+        id
+        site_id
+        asset_type
+        asset_type___name
+        criticality
+        criticality___name
+        firmware
+        ghost
+        insights
+        i_pv4
+        i_pv6
+        mac
+        model
+        name
+        network_id
+        risk_level
+        site_name
+        total_cves_count
+        vendor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resource_id = SKIP,
+                   id = SKIP,
+                   site_id = SKIP,
+                   asset_type = SKIP,
+                   asset_type___name = SKIP,
+                   criticality = SKIP,
+                   criticality___name = SKIP,
+                   firmware = SKIP,
+                   ghost = SKIP,
+                   insights = SKIP,
+                   i_pv4 = SKIP,
+                   i_pv6 = SKIP,
+                   mac = SKIP,
+                   model = SKIP,
+                   name = SKIP,
+                   network_id = SKIP,
+                   risk_level = SKIP,
+                   site_name = SKIP,
+                   total_cves_count = SKIP,
+                   vendor = SKIP)
+      @resource_id = resource_id unless resource_id == SKIP
+      @id = id unless id == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @asset_type = asset_type unless asset_type == SKIP
+      @asset_type___name = asset_type___name unless asset_type___name == SKIP
+      @criticality = criticality unless criticality == SKIP
+      @criticality___name = criticality___name unless criticality___name == SKIP
+      @firmware = firmware unless firmware == SKIP
+      @ghost = ghost unless ghost == SKIP
+      @insights = insights unless insights == SKIP
+      @i_pv4 = i_pv4 unless i_pv4 == SKIP
+      @i_pv6 = i_pv6 unless i_pv6 == SKIP
+      @mac = mac unless mac == SKIP
+      @model = model unless model == SKIP
+      @name = name unless name == SKIP
+      @network_id = network_id unless network_id == SKIP
+      @risk_level = risk_level unless risk_level == SKIP
+      @site_name = site_name unless site_name == SKIP
+      @total_cves_count = total_cves_count unless total_cves_count == SKIP
+      @vendor = vendor unless vendor == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      resource_id = hash.key?('resource_id') ? hash['resource_id'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      asset_type = hash.key?('asset_type') ? hash['asset_type'] : SKIP
+      asset_type___name =
+        hash.key?('asset_type__(name)') ? hash['asset_type__(name)'] : SKIP
+      criticality = hash.key?('criticality') ? hash['criticality'] : SKIP
+      criticality___name =
+        hash.key?('criticality__(name)') ? hash['criticality__(name)'] : SKIP
+      firmware = hash.key?('firmware') ? hash['firmware'] : SKIP
+      ghost = hash.key?('ghost') ? hash['ghost'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      insights = nil
+      unless hash['insights'].nil?
+        insights = []
+        hash['insights'].each do |structure|
+          insights << (SlimInsight.from_hash(structure) if structure)
+        end
+      end
+
+      insights = SKIP unless hash.key?('insights')
+      i_pv4 = hash.key?('IPv4') ? hash['IPv4'] : SKIP
+      i_pv6 = hash.key?('IPv6') ? hash['IPv6'] : SKIP
+      mac = hash.key?('mac') ? hash['mac'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      network_id = hash.key?('network_id') ? hash['network_id'] : SKIP
+      risk_level = hash.key?('risk_level') ? hash['risk_level'] : SKIP
+      site_name = hash.key?('site_name') ? hash['site_name'] : SKIP
+      total_cves_count =
+        hash.key?('total_cves_count') ? hash['total_cves_count'] : SKIP
+      vendor = hash.key?('vendor') ? hash['vendor'] : SKIP
+
+      # Create object from extracted values.
+      AssetsWithInsights.new(resource_id,
+                             id,
+                             site_id,
+                             asset_type,
+                             asset_type___name,
+                             criticality,
+                             criticality___name,
+                             firmware,
+                             ghost,
+                             insights,
+                             i_pv4,
+                             i_pv6,
+                             mac,
+                             model,
+                             name,
+                             network_id,
+                             risk_level,
+                             site_name,
+                             total_cves_count,
+                             vendor)
+    end
+  end
+end

data/lib/ctd_documentation/models/assets_with_insights_response.rb

@@ -0,0 +1,90 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # AssetsWithInsightsResponse Model.
+  class AssetsWithInsightsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :count_filtered
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :count_in_page
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :count_total
+
+    # TODO: Write general description for this method
+    # @return [List of AssetsWithInsights]
+    attr_accessor :objects
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count_filtered'] = 'count_filtered'
+      @_hash['count_in_page'] = 'count_in_page'
+      @_hash['count_total'] = 'count_total'
+      @_hash['objects'] = 'objects'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        count_filtered
+        count_in_page
+        count_total
+        objects
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count_filtered = SKIP,
+                   count_in_page = SKIP,
+                   count_total = SKIP,
+                   objects = SKIP)
+      @count_filtered = count_filtered unless count_filtered == SKIP
+      @count_in_page = count_in_page unless count_in_page == SKIP
+      @count_total = count_total unless count_total == SKIP
+      @objects = objects unless objects == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count_filtered =
+        hash.key?('count_filtered') ? hash['count_filtered'] : SKIP
+      count_in_page = hash.key?('count_in_page') ? hash['count_in_page'] : SKIP
+      count_total = hash.key?('count_total') ? hash['count_total'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      objects = nil
+      unless hash['objects'].nil?
+        objects = []
+        hash['objects'].each do |structure|
+          objects << (AssetsWithInsights.from_hash(structure) if structure)
+        end
+      end
+
+      objects = SKIP unless hash.key?('objects')
+
+      # Create object from extracted values.
+      AssetsWithInsightsResponse.new(count_filtered,
+                                     count_in_page,
+                                     count_total,
+                                     objects)
+    end
+  end
+end

data/lib/ctd_documentation/models/authenticate.rb

@@ -0,0 +1,57 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # Authenticate Model.
+  class Authenticate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :username
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(username = nil,
+                   password = nil)
+      @username = username
+      @password = password
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      username = hash.key?('username') ? hash['username'] : nil
+      password = hash.key?('password') ? hash['password'] : nil
+
+      # Create object from extracted values.
+      Authenticate.new(username,
+                       password)
+    end
+  end
+end

data/lib/ctd_documentation/models/base_model.rb

@@ -0,0 +1,58 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_#{name}", *params)
+            else
+              hash[key] = send("to_#{name}")
+            end
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/ctd_documentation/models/base_task.rb

@@ -0,0 +1,198 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # BaseTask Model.
+  class BaseTask < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :allowed_days
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :allowed_run_time_end
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :allowed_run_time_start
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [Integer]
+    attr_accessor :type
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :end_time
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :interval
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [TrueClass|FalseClass]
+    attr_accessor :is_recurring
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :name
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :resource_id
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [Float]
+    attr_accessor :site_id
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :status
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [TrueClass|FalseClass]
+    attr_accessor :valid
+
+    # A string that represents specific days in a week, Sunday being 0 and
+    # Friday being 6. To select more than a specific day just concatenate the
+    # day number to the string
+    # @return [String]
+    attr_accessor :start_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['allowed_days'] = 'allowed_days'
+      @_hash['allowed_run_time_end'] = 'allowed_run_time_end'
+      @_hash['allowed_run_time_start'] = 'allowed_run_time_start'
+      @_hash['type'] = 'type'
+      @_hash['end_time'] = 'end_time'
+      @_hash['interval'] = 'interval'
+      @_hash['is_recurring'] = 'is_recurring'
+      @_hash['name'] = 'name'
+      @_hash['resource_id'] = 'resource_id'
+      @_hash['site_id'] = 'site_id'
+      @_hash['status'] = 'status'
+      @_hash['valid'] = 'valid'
+      @_hash['start_time'] = 'start_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        allowed_days
+        allowed_run_time_end
+        allowed_run_time_start
+        type
+        end_time
+        interval
+        is_recurring
+        name
+        resource_id
+        site_id
+        status
+        valid
+        start_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(allowed_days = SKIP,
+                   allowed_run_time_end = SKIP,
+                   allowed_run_time_start = SKIP,
+                   type = SKIP,
+                   end_time = SKIP,
+                   interval = SKIP,
+                   is_recurring = SKIP,
+                   name = SKIP,
+                   resource_id = SKIP,
+                   site_id = SKIP,
+                   status = SKIP,
+                   valid = SKIP,
+                   start_time = SKIP)
+      @allowed_days = allowed_days unless allowed_days == SKIP
+      @allowed_run_time_end = allowed_run_time_end unless allowed_run_time_end == SKIP
+      @allowed_run_time_start = allowed_run_time_start unless allowed_run_time_start == SKIP
+      @type = type unless type == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @interval = interval unless interval == SKIP
+      @is_recurring = is_recurring unless is_recurring == SKIP
+      @name = name unless name == SKIP
+      @resource_id = resource_id unless resource_id == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @status = status unless status == SKIP
+      @valid = valid unless valid == SKIP
+      @start_time = start_time unless start_time == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      allowed_days = hash.key?('allowed_days') ? hash['allowed_days'] : SKIP
+      allowed_run_time_end =
+        hash.key?('allowed_run_time_end') ? hash['allowed_run_time_end'] : SKIP
+      allowed_run_time_start =
+        hash.key?('allowed_run_time_start') ? hash['allowed_run_time_start'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      end_time = hash.key?('end_time') ? hash['end_time'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      is_recurring = hash.key?('is_recurring') ? hash['is_recurring'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      resource_id = hash.key?('resource_id') ? hash['resource_id'] : SKIP
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      valid = hash.key?('valid') ? hash['valid'] : SKIP
+      start_time = hash.key?('start_time') ? hash['start_time'] : SKIP
+
+      # Create object from extracted values.
+      BaseTask.new(allowed_days,
+                   allowed_run_time_end,
+                   allowed_run_time_start,
+                   type,
+                   end_time,
+                   interval,
+                   is_recurring,
+                   name,
+                   resource_id,
+                   site_id,
+                   status,
+                   valid,
+                   start_time)
+    end
+  end
+end