emass_client 3.12.0 → 3.22.0

data/lib/emass_client/models/sw_baseline_optional_fields.rb

@@ -0,0 +1,563 @@
+=begin
+#Enterprise Mission Assurance Support Service (eMASS)
+
+#The eMASS Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records.  The eMASS API provides an interface for application to communicate eMASS Services. For information on how to register and use the eMASS API reference the [eMASS API Getting Started](eMASSGettingStarted.md).  Additional information about eMASS can be obtain by contacting the National Industrial Security Program (NISP). Points of Contact are: 
+
+The version of the OpenAPI document: v3.22
+Contact: disa.global.servicedesk.mbx.ma-ticket-request@mail.mil
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module EmassClient
+  class SwBaselineOptionalFields
+    # [Optional] Type of the software asset.
+    attr_accessor :software_type
+
+    # [Optional] Parent system of the software asset.
+    attr_accessor :parent_system
+
+    # [Optional] Subsystem of the software asset.
+    attr_accessor :subsystem
+
+    # [Optional] Network of the software asset.
+    attr_accessor :network
+
+    # [Optional] Hosting environment of the software asset.
+    attr_accessor :hosting_environment
+
+    # [Optional] Dependencies of the software asset.
+    attr_accessor :software_dependencies
+
+    # [Optional] Cryptographic hash of the software asset.
+    attr_accessor :cryptographic_hash
+
+    # [Optional] In-service data of the software asset.
+    attr_accessor :in_service_data
+
+    # [Optional] IT budget UII of the software asset.
+    attr_accessor :it_budget_uii
+
+    # [Optional] Fiscal year (FY) of the software asset.
+    attr_accessor :fiscal_year
+
+    # [Optional] Period of performance (POP) end date of the software asset.
+    attr_accessor :pop_end_date
+
+    # [Optional] License or contract number of the software asset.
+    attr_accessor :license_or_contract
+
+    # [Optional] License term of the software asset.
+    attr_accessor :license_term
+
+    # [Optional] Cost per license of the software asset. Number will be converted to display 2 decimal points.
+    attr_accessor :cost_per_license
+
+    # [Optional] Total licenses of the software asset.
+    attr_accessor :total_licenses
+
+    # [Optional] Total license cost of the software asset. Number will be converted to display 2 decimal points.
+    attr_accessor :total_license_cost
+
+    # [Optional] Number of licenses used for the software asset.
+    attr_accessor :licenses_used
+
+    # [Optional] Point of contact (POC) for the software asset.
+    attr_accessor :license_poc
+
+    # [Optional] License renewal date for the software asset.
+    attr_accessor :license_renewal_date
+
+    # [Optional] License expiration date for the software asset.
+    attr_accessor :license_expiration_date
+
+    # [Optional] Approval status of the software asset.
+    attr_accessor :approval_status
+
+    # [Optional] Release date of the software asset.
+    attr_accessor :release_date
+
+    # [Optional] Maintenance date of the software asset.
+    attr_accessor :maintenance_date
+
+    # [Optional] Retirement date of the software asset.
+    attr_accessor :retirement_date
+
+    # [Optional] End of life support date of the software asset.
+    attr_accessor :end_of_life_support_date
+
+    # [Optional] If set, the Extended End of Life/Support Date cannot occur prior to the End of Life/Support Date.
+    attr_accessor :extended_end_of_life_support_date
+
+    # [Optional] Indicates whether the asset is a critical information system asset.
+    attr_accessor :critical_asset
+
+    # [Optional] Location of the software asset.
+    attr_accessor :location
+
+    # [Optional] Purpose of the software asset.
+    attr_accessor :purpose
+
+    # [Optional] Unsupported operating system. VA only.
+    attr_accessor :unsupported_operating_system
+
+    # [Optional] Unapproved software from TRM. VA only
+    attr_accessor :unapproved_software_from_trm
+
+    # [Optional] Approved waiver. VA only
+    attr_accessor :approved_waiver
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'software_type' => :'softwareType',
+        :'parent_system' => :'parentSystem',
+        :'subsystem' => :'subsystem',
+        :'network' => :'network',
+        :'hosting_environment' => :'hostingEnvironment',
+        :'software_dependencies' => :'softwareDependencies',
+        :'cryptographic_hash' => :'cryptographicHash',
+        :'in_service_data' => :'inServiceData',
+        :'it_budget_uii' => :'itBudgetUii',
+        :'fiscal_year' => :'fiscalYear',
+        :'pop_end_date' => :'popEndDate',
+        :'license_or_contract' => :'licenseOrContract',
+        :'license_term' => :'licenseTerm',
+        :'cost_per_license' => :'costPerLicense',
+        :'total_licenses' => :'totalLicenses',
+        :'total_license_cost' => :'totalLicenseCost',
+        :'licenses_used' => :'licensesUsed',
+        :'license_poc' => :'licensePoc',
+        :'license_renewal_date' => :'licenseRenewalDate',
+        :'license_expiration_date' => :'licenseExpirationDate',
+        :'approval_status' => :'approvalStatus',
+        :'release_date' => :'releaseDate',
+        :'maintenance_date' => :'maintenanceDate',
+        :'retirement_date' => :'retirementDate',
+        :'end_of_life_support_date' => :'endOfLifeSupportDate',
+        :'extended_end_of_life_support_date' => :'extendedEndOfLifeSupportDate',
+        :'critical_asset' => :'criticalAsset',
+        :'location' => :'location',
+        :'purpose' => :'purpose',
+        :'unsupported_operating_system' => :'unsupportedOperatingSystem',
+        :'unapproved_software_from_trm' => :'unapprovedSoftwareFromTrm',
+        :'approved_waiver' => :'approvedWaiver'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'software_type' => :'String',
+        :'parent_system' => :'String',
+        :'subsystem' => :'String',
+        :'network' => :'String',
+        :'hosting_environment' => :'String',
+        :'software_dependencies' => :'String',
+        :'cryptographic_hash' => :'String',
+        :'in_service_data' => :'String',
+        :'it_budget_uii' => :'String',
+        :'fiscal_year' => :'String',
+        :'pop_end_date' => :'Integer',
+        :'license_or_contract' => :'String',
+        :'license_term' => :'String',
+        :'cost_per_license' => :'Float',
+        :'total_licenses' => :'Integer',
+        :'total_license_cost' => :'Float',
+        :'licenses_used' => :'Integer',
+        :'license_poc' => :'String',
+        :'license_renewal_date' => :'Integer',
+        :'license_expiration_date' => :'Integer',
+        :'approval_status' => :'String',
+        :'release_date' => :'Integer',
+        :'maintenance_date' => :'Integer',
+        :'retirement_date' => :'Integer',
+        :'end_of_life_support_date' => :'Integer',
+        :'extended_end_of_life_support_date' => :'Integer',
+        :'critical_asset' => :'Boolean',
+        :'location' => :'String',
+        :'purpose' => :'String',
+        :'unsupported_operating_system' => :'Boolean',
+        :'unapproved_software_from_trm' => :'Boolean',
+        :'approved_waiver' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'software_type',
+        :'parent_system',
+        :'subsystem',
+        :'network',
+        :'hosting_environment',
+        :'software_dependencies',
+        :'cryptographic_hash',
+        :'in_service_data',
+        :'it_budget_uii',
+        :'fiscal_year',
+        :'pop_end_date',
+        :'license_or_contract',
+        :'license_term',
+        :'cost_per_license',
+        :'total_licenses',
+        :'total_license_cost',
+        :'licenses_used',
+        :'license_poc',
+        :'license_renewal_date',
+        :'license_expiration_date',
+        :'approval_status',
+        :'release_date',
+        :'maintenance_date',
+        :'retirement_date',
+        :'end_of_life_support_date',
+        :'extended_end_of_life_support_date',
+        :'critical_asset',
+        :'location',
+        :'purpose',
+        :'unsupported_operating_system',
+        :'unapproved_software_from_trm',
+        :'approved_waiver'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::SwBaselineOptionalFields` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::SwBaselineOptionalFields`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'software_type')
+        self.software_type = attributes[:'software_type']
+      end
+
+      if attributes.key?(:'parent_system')
+        self.parent_system = attributes[:'parent_system']
+      end
+
+      if attributes.key?(:'subsystem')
+        self.subsystem = attributes[:'subsystem']
+      end
+
+      if attributes.key?(:'network')
+        self.network = attributes[:'network']
+      end
+
+      if attributes.key?(:'hosting_environment')
+        self.hosting_environment = attributes[:'hosting_environment']
+      end
+
+      if attributes.key?(:'software_dependencies')
+        self.software_dependencies = attributes[:'software_dependencies']
+      end
+
+      if attributes.key?(:'cryptographic_hash')
+        self.cryptographic_hash = attributes[:'cryptographic_hash']
+      end
+
+      if attributes.key?(:'in_service_data')
+        self.in_service_data = attributes[:'in_service_data']
+      end
+
+      if attributes.key?(:'it_budget_uii')
+        self.it_budget_uii = attributes[:'it_budget_uii']
+      end
+
+      if attributes.key?(:'fiscal_year')
+        self.fiscal_year = attributes[:'fiscal_year']
+      end
+
+      if attributes.key?(:'pop_end_date')
+        self.pop_end_date = attributes[:'pop_end_date']
+      end
+
+      if attributes.key?(:'license_or_contract')
+        self.license_or_contract = attributes[:'license_or_contract']
+      end
+
+      if attributes.key?(:'license_term')
+        self.license_term = attributes[:'license_term']
+      end
+
+      if attributes.key?(:'cost_per_license')
+        self.cost_per_license = attributes[:'cost_per_license']
+      end
+
+      if attributes.key?(:'total_licenses')
+        self.total_licenses = attributes[:'total_licenses']
+      end
+
+      if attributes.key?(:'total_license_cost')
+        self.total_license_cost = attributes[:'total_license_cost']
+      end
+
+      if attributes.key?(:'licenses_used')
+        self.licenses_used = attributes[:'licenses_used']
+      end
+
+      if attributes.key?(:'license_poc')
+        self.license_poc = attributes[:'license_poc']
+      end
+
+      if attributes.key?(:'license_renewal_date')
+        self.license_renewal_date = attributes[:'license_renewal_date']
+      end
+
+      if attributes.key?(:'license_expiration_date')
+        self.license_expiration_date = attributes[:'license_expiration_date']
+      end
+
+      if attributes.key?(:'approval_status')
+        self.approval_status = attributes[:'approval_status']
+      end
+
+      if attributes.key?(:'release_date')
+        self.release_date = attributes[:'release_date']
+      end
+
+      if attributes.key?(:'maintenance_date')
+        self.maintenance_date = attributes[:'maintenance_date']
+      end
+
+      if attributes.key?(:'retirement_date')
+        self.retirement_date = attributes[:'retirement_date']
+      end
+
+      if attributes.key?(:'end_of_life_support_date')
+        self.end_of_life_support_date = attributes[:'end_of_life_support_date']
+      end
+
+      if attributes.key?(:'extended_end_of_life_support_date')
+        self.extended_end_of_life_support_date = attributes[:'extended_end_of_life_support_date']
+      end
+
+      if attributes.key?(:'critical_asset')
+        self.critical_asset = attributes[:'critical_asset']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'purpose')
+        self.purpose = attributes[:'purpose']
+      end
+
+      if attributes.key?(:'unsupported_operating_system')
+        self.unsupported_operating_system = attributes[:'unsupported_operating_system']
+      end
+
+      if attributes.key?(:'unapproved_software_from_trm')
+        self.unapproved_software_from_trm = attributes[:'unapproved_software_from_trm']
+      end
+
+      if attributes.key?(:'approved_waiver')
+        self.approved_waiver = attributes[:'approved_waiver']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          software_type == o.software_type &&
+          parent_system == o.parent_system &&
+          subsystem == o.subsystem &&
+          network == o.network &&
+          hosting_environment == o.hosting_environment &&
+          software_dependencies == o.software_dependencies &&
+          cryptographic_hash == o.cryptographic_hash &&
+          in_service_data == o.in_service_data &&
+          it_budget_uii == o.it_budget_uii &&
+          fiscal_year == o.fiscal_year &&
+          pop_end_date == o.pop_end_date &&
+          license_or_contract == o.license_or_contract &&
+          license_term == o.license_term &&
+          cost_per_license == o.cost_per_license &&
+          total_licenses == o.total_licenses &&
+          total_license_cost == o.total_license_cost &&
+          licenses_used == o.licenses_used &&
+          license_poc == o.license_poc &&
+          license_renewal_date == o.license_renewal_date &&
+          license_expiration_date == o.license_expiration_date &&
+          approval_status == o.approval_status &&
+          release_date == o.release_date &&
+          maintenance_date == o.maintenance_date &&
+          retirement_date == o.retirement_date &&
+          end_of_life_support_date == o.end_of_life_support_date &&
+          extended_end_of_life_support_date == o.extended_end_of_life_support_date &&
+          critical_asset == o.critical_asset &&
+          location == o.location &&
+          purpose == o.purpose &&
+          unsupported_operating_system == o.unsupported_operating_system &&
+          unapproved_software_from_trm == o.unapproved_software_from_trm &&
+          approved_waiver == o.approved_waiver
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [software_type, parent_system, subsystem, network, hosting_environment, software_dependencies, cryptographic_hash, in_service_data, it_budget_uii, fiscal_year, pop_end_date, license_or_contract, license_term, cost_per_license, total_licenses, total_license_cost, licenses_used, license_poc, license_renewal_date, license_expiration_date, approval_status, release_date, maintenance_date, retirement_date, end_of_life_support_date, extended_end_of_life_support_date, critical_asset, location, purpose, unsupported_operating_system, unapproved_software_from_trm, approved_waiver].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = EmassClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end