emass_client 3.12.0 → 3.22.0

data/lib/emass_client/models/poam_optional_fields.rb

@@ -0,0 +1,409 @@
+=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 PoamOptionalFields
+    # [Optional] Unique identifier external to the eMASS application for use with associating POA&Ms. 100 Characters.
+    attr_accessor :external_uid
+
+    # [Optional] Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined.
+    attr_accessor :control_acronym
+
+    # [Optional] The Security Control Assessment Procedure being associated with the POA&M Item.
+    attr_accessor :assessment_procedure
+
+    # [Optional] Security Checks that are associated with the POA&M.
+    attr_accessor :security_checks
+
+    # [Optional] Scan vulnerability ratting Values include the following options: (Very Low, Low, Moderate,High,Very High)
+    attr_accessor :raw_severity
+
+    # [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High)
+    attr_accessor :relevance_of_threat
+
+    # [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High)
+    attr_accessor :likelihood
+
+    # [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High)
+    attr_accessor :impact
+
+    # [Optional] Include description of Security Control's impact.
+    attr_accessor :impact_description
+
+    # [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High)
+    attr_accessor :residual_risk_level
+
+    # [Optional] Include recommendations. Character Limit = 2,000.
+    attr_accessor :recommendations
+
+    # [Optional] Include mitigation explanation. 2000 Characters.
+    attr_accessor :mitigations
+
+    # [Optional] Indicate the risk level expected after any proposed mitigations are implemented. Proposed mitigations should be appropriately documented as POA&M milestones. Navy only.
+    attr_accessor :resulting_residual_risk_level_after_proposed_mitigations
+
+    # [Optional] A predisposing condition is a condition existing within an organization, a mission or business process, enterprise architecture, information system/PIT, or environment of operation, which affects (i.e., increases or decreases) the likelihood that threat events, once initiated, result in adverse impacts. Navy only.
+    attr_accessor :predisposing_conditions
+
+    # [Optional] Describe the identified threat(s) and relevance to the information system. Navy only.
+    attr_accessor :threat_description
+
+    # [Optional] List any affected devices by hostname. If all devices in the information system are affected, state 'system' or 'all'. Navy only
+    attr_accessor :devices_affected
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'external_uid' => :'externalUid',
+        :'control_acronym' => :'controlAcronym',
+        :'assessment_procedure' => :'assessmentProcedure',
+        :'security_checks' => :'securityChecks',
+        :'raw_severity' => :'rawSeverity',
+        :'relevance_of_threat' => :'relevanceOfThreat',
+        :'likelihood' => :'likelihood',
+        :'impact' => :'impact',
+        :'impact_description' => :'impactDescription',
+        :'residual_risk_level' => :'residualRiskLevel',
+        :'recommendations' => :'recommendations',
+        :'mitigations' => :'mitigations',
+        :'resulting_residual_risk_level_after_proposed_mitigations' => :'resultingResidualRiskLevelAfterProposedMitigations',
+        :'predisposing_conditions' => :'predisposingConditions',
+        :'threat_description' => :'threatDescription',
+        :'devices_affected' => :'devicesAffected'
+      }
+    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
+      {
+        :'external_uid' => :'String',
+        :'control_acronym' => :'String',
+        :'assessment_procedure' => :'String',
+        :'security_checks' => :'String',
+        :'raw_severity' => :'String',
+        :'relevance_of_threat' => :'String',
+        :'likelihood' => :'String',
+        :'impact' => :'String',
+        :'impact_description' => :'String',
+        :'residual_risk_level' => :'String',
+        :'recommendations' => :'String',
+        :'mitigations' => :'String',
+        :'resulting_residual_risk_level_after_proposed_mitigations' => :'String',
+        :'predisposing_conditions' => :'String',
+        :'threat_description' => :'String',
+        :'devices_affected' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'resulting_residual_risk_level_after_proposed_mitigations',
+        :'predisposing_conditions',
+        :'threat_description',
+        :'devices_affected'
+      ])
+    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::PoamOptionalFields` 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::PoamOptionalFields`. 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?(:'external_uid')
+        self.external_uid = attributes[:'external_uid']
+      end
+
+      if attributes.key?(:'control_acronym')
+        self.control_acronym = attributes[:'control_acronym']
+      end
+
+      if attributes.key?(:'assessment_procedure')
+        self.assessment_procedure = attributes[:'assessment_procedure']
+      end
+
+      if attributes.key?(:'security_checks')
+        self.security_checks = attributes[:'security_checks']
+      end
+
+      if attributes.key?(:'raw_severity')
+        self.raw_severity = attributes[:'raw_severity']
+      end
+
+      if attributes.key?(:'relevance_of_threat')
+        self.relevance_of_threat = attributes[:'relevance_of_threat']
+      end
+
+      if attributes.key?(:'likelihood')
+        self.likelihood = attributes[:'likelihood']
+      end
+
+      if attributes.key?(:'impact')
+        self.impact = attributes[:'impact']
+      end
+
+      if attributes.key?(:'impact_description')
+        self.impact_description = attributes[:'impact_description']
+      end
+
+      if attributes.key?(:'residual_risk_level')
+        self.residual_risk_level = attributes[:'residual_risk_level']
+      end
+
+      if attributes.key?(:'recommendations')
+        self.recommendations = attributes[:'recommendations']
+      end
+
+      if attributes.key?(:'mitigations')
+        self.mitigations = attributes[:'mitigations']
+      end
+
+      if attributes.key?(:'resulting_residual_risk_level_after_proposed_mitigations')
+        self.resulting_residual_risk_level_after_proposed_mitigations = attributes[:'resulting_residual_risk_level_after_proposed_mitigations']
+      end
+
+      if attributes.key?(:'predisposing_conditions')
+        self.predisposing_conditions = attributes[:'predisposing_conditions']
+      end
+
+      if attributes.key?(:'threat_description')
+        self.threat_description = attributes[:'threat_description']
+      end
+
+      if attributes.key?(:'devices_affected')
+        self.devices_affected = attributes[:'devices_affected']
+      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'
+      resulting_residual_risk_level_after_proposed_mitigations_validator = EnumAttributeValidator.new('String', ["Very Low", "Low", "Moderate", "High", "Very High", "unknown_default_open_api"])
+      return false unless resulting_residual_risk_level_after_proposed_mitigations_validator.valid?(@resulting_residual_risk_level_after_proposed_mitigations)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] resulting_residual_risk_level_after_proposed_mitigations Object to be assigned
+    def resulting_residual_risk_level_after_proposed_mitigations=(resulting_residual_risk_level_after_proposed_mitigations)
+      validator = EnumAttributeValidator.new('String', ["Very Low", "Low", "Moderate", "High", "Very High", "unknown_default_open_api"])
+      unless validator.valid?(resulting_residual_risk_level_after_proposed_mitigations)
+        fail ArgumentError, "invalid value for \"resulting_residual_risk_level_after_proposed_mitigations\", must be one of #{validator.allowable_values}."
+      end
+      @resulting_residual_risk_level_after_proposed_mitigations = resulting_residual_risk_level_after_proposed_mitigations
+    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 &&
+          external_uid == o.external_uid &&
+          control_acronym == o.control_acronym &&
+          assessment_procedure == o.assessment_procedure &&
+          security_checks == o.security_checks &&
+          raw_severity == o.raw_severity &&
+          relevance_of_threat == o.relevance_of_threat &&
+          likelihood == o.likelihood &&
+          impact == o.impact &&
+          impact_description == o.impact_description &&
+          residual_risk_level == o.residual_risk_level &&
+          recommendations == o.recommendations &&
+          mitigations == o.mitigations &&
+          resulting_residual_risk_level_after_proposed_mitigations == o.resulting_residual_risk_level_after_proposed_mitigations &&
+          predisposing_conditions == o.predisposing_conditions &&
+          threat_description == o.threat_description &&
+          devices_affected == o.devices_affected
+    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
+      [external_uid, control_acronym, assessment_procedure, security_checks, raw_severity, relevance_of_threat, likelihood, impact, impact_description, residual_risk_level, recommendations, mitigations, resulting_residual_risk_level_after_proposed_mitigations, predisposing_conditions, threat_description, devices_affected].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

data/lib/emass_client/models/poam_post_put_del.rb

@@ -1,12 +1,12 @@
 =begin
 #Enterprise Mission Assurance Support Service (eMASS)
 
-#The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records.   <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API  requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</br></br>  Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key.  The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br>  <strong>Available Request Headers</strong></br> <table>   <tr>     <th align=left>key</th>     <th align=left>Example Value</th>     <th align=left>Description</th>   </tr>   <tr>     <td>`api-key`</td>     <td>api-key-provided-by-emass</td>     <td>This API key must be provided in the request header for all endpoint calls</td>   </tr>   <tr>     <td>`user-uid`</td>     <td>USER.UID.KEY</td>     <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td>   </tr>   <tr>     <td></td><td></td>     <td>       Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC     </td>   </tr> </table>  </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records.  To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC: 
+#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.12
-Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
+The version of the OpenAPI document: v3.22
+Contact: disa.global.servicedesk.mbx.ma-ticket-request@mail.mil
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.1.0-SNAPSHOT
+Generator version: 7.12.0-SNAPSHOT
 
 =end
 
@@ -40,9 +40,14 @@ module EmassClient
       }
     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
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -71,9 +76,10 @@ module EmassClient
       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 (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::PoamPostPutDel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::PoamPostPutDel`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -106,8 +112,8 @@ module EmassClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@errors.nil? && @errors.length > 3
-        invalid_properties.push('invalid value for "errors", number of items must be less than or equal to 3.')
+      if !@errors.nil? && @errors.length > 25
+        invalid_properties.push('invalid value for "errors", number of items must be less than or equal to 25.')
       end
 
       if !@errors.nil? && @errors.length < 1
@@ -121,7 +127,7 @@ module EmassClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if !@errors.nil? && @errors.length > 3
+      return false if !@errors.nil? && @errors.length > 25
       return false if !@errors.nil? && @errors.length < 1
       true
     end
@@ -129,8 +135,8 @@ module EmassClient
     # Custom attribute writer method with validation
     # @param [Object] errors Value to be assigned
     def errors=(errors)
-      if !errors.nil? && errors.length > 3
-        fail ArgumentError, 'invalid value for "errors", number of items must be less than or equal to 3.'
+      if !errors.nil? && errors.length > 25
+        fail ArgumentError, 'invalid value for "errors", number of items must be less than or equal to 25.'
       end
 
       if !errors.nil? && errors.length < 1
@@ -226,7 +232,7 @@ module EmassClient
       else # model
         # models (e.g. Pet) or oneOf
         klass = EmassClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end