emass_client 3.12.0 → 3.22.0

data/lib/emass_client/models/hw_baseline_response_get_data_inner.rb

@@ -0,0 +1,429 @@
+=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 HwBaselineResponseGetDataInner
+    # [Required] Unique eMASS system identifier.
+    attr_accessor :system_id
+
+    # [Read-Only] GUID identifying the specific hardware asset. Required for a PUT call.
+    attr_accessor :hardware_id
+
+    # [Required] Name of the hardware asset.
+    attr_accessor :asset_name
+
+    # [Optional] Type of the hardware asset.
+    attr_accessor :component_type
+
+    # [Optional] Nickname of the hardware asset.
+    attr_accessor :nickname
+
+    # [Optional] IP address of the hardware asset.
+    attr_accessor :asset_ip_address
+
+    # [Optional] Public facing is defined as any asset that is accessible from a commercial connection.
+    attr_accessor :public_facing
+
+    # [Optional] Determine if this is a virtual hardware asset.
+    attr_accessor :virtual_asset
+
+    # [Optional] Manufacturer of the hardware asset. Populated with \"Virtual\" by default if Virtual Asset is true, however this can be overridden.
+    attr_accessor :manufacturer
+
+    # [Optional] Model number of the hardware asset. Populated with \"Virtual\" by default if Virtual Asset is true, however this can be overridden
+    attr_accessor :model_number
+
+    # [Optional] Serial number of the hardware asset. Populated with \"Virtual\" by default if Virtual Asset is true, however this can be overridden.
+    attr_accessor :serial_number
+
+    # [Optional] Operating System, IOS, or Firmware version of the hardware asset.
+    attr_accessor :os_ios_fw_version
+
+    # [Optional] Memory size / type of the hardware asset.
+    attr_accessor :memory_size_type
+
+    # [Optional] Location of the hardware asset.
+    attr_accessor :location
+
+    # [Optional] Approval status of the hardware asset.
+    attr_accessor :approval_status
+
+    # [Optional] Indicates whether the asset is a critical information system asset.
+    attr_accessor :critical_asset
+
+    # [Conditional] Public facing FQDN. Only applicable if Public Facing is set to true.
+    attr_accessor :public_facing_fqdn
+
+    # [Conditional] Public facing IP address. Only applicable if Public Facing is set to true.
+    attr_accessor :public_facing_ip_address
+
+    # [Conditional] Public facing URLs. Only applicable if Public Facing is set to true.
+    attr_accessor :public_facing_urls
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'system_id' => :'systemId',
+        :'hardware_id' => :'hardwareId',
+        :'asset_name' => :'assetName',
+        :'component_type' => :'componentType',
+        :'nickname' => :'nickname',
+        :'asset_ip_address' => :'assetIpAddress',
+        :'public_facing' => :'publicFacing',
+        :'virtual_asset' => :'virtualAsset',
+        :'manufacturer' => :'manufacturer',
+        :'model_number' => :'modelNumber',
+        :'serial_number' => :'serialNumber',
+        :'os_ios_fw_version' => :'OsIosFwVersion',
+        :'memory_size_type' => :'memorySizeType',
+        :'location' => :'location',
+        :'approval_status' => :'approvalStatus',
+        :'critical_asset' => :'criticalAsset',
+        :'public_facing_fqdn' => :'publicFacingFqdn',
+        :'public_facing_ip_address' => :'publicFacingIpAddress',
+        :'public_facing_urls' => :'publicFacingUrls'
+      }
+    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
+      {
+        :'system_id' => :'Integer',
+        :'hardware_id' => :'String',
+        :'asset_name' => :'String',
+        :'component_type' => :'String',
+        :'nickname' => :'String',
+        :'asset_ip_address' => :'String',
+        :'public_facing' => :'Boolean',
+        :'virtual_asset' => :'Boolean',
+        :'manufacturer' => :'String',
+        :'model_number' => :'String',
+        :'serial_number' => :'String',
+        :'os_ios_fw_version' => :'String',
+        :'memory_size_type' => :'String',
+        :'location' => :'String',
+        :'approval_status' => :'String',
+        :'critical_asset' => :'Boolean',
+        :'public_facing_fqdn' => :'String',
+        :'public_facing_ip_address' => :'String',
+        :'public_facing_urls' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'hardware_id',
+        :'component_type',
+        :'nickname',
+        :'asset_ip_address',
+        :'public_facing',
+        :'virtual_asset',
+        :'manufacturer',
+        :'model_number',
+        :'serial_number',
+        :'os_ios_fw_version',
+        :'memory_size_type',
+        :'location',
+        :'approval_status',
+        :'critical_asset',
+        :'public_facing_fqdn',
+        :'public_facing_ip_address',
+        :'public_facing_urls'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'HwBaselineConditionalFields',
+      :'HwBaselineIds',
+      :'HwBaselineOptionalFields',
+      :'HwBaselineReadOnlyFields',
+      :'HwBaselineRequiredFields'
+      ]
+    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::HwBaselineResponseGetDataInner` 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::HwBaselineResponseGetDataInner`. 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?(:'system_id')
+        self.system_id = attributes[:'system_id']
+      end
+
+      if attributes.key?(:'hardware_id')
+        self.hardware_id = attributes[:'hardware_id']
+      end
+
+      if attributes.key?(:'asset_name')
+        self.asset_name = attributes[:'asset_name']
+      end
+
+      if attributes.key?(:'component_type')
+        self.component_type = attributes[:'component_type']
+      end
+
+      if attributes.key?(:'nickname')
+        self.nickname = attributes[:'nickname']
+      end
+
+      if attributes.key?(:'asset_ip_address')
+        self.asset_ip_address = attributes[:'asset_ip_address']
+      end
+
+      if attributes.key?(:'public_facing')
+        self.public_facing = attributes[:'public_facing']
+      end
+
+      if attributes.key?(:'virtual_asset')
+        self.virtual_asset = attributes[:'virtual_asset']
+      end
+
+      if attributes.key?(:'manufacturer')
+        self.manufacturer = attributes[:'manufacturer']
+      end
+
+      if attributes.key?(:'model_number')
+        self.model_number = attributes[:'model_number']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      end
+
+      if attributes.key?(:'os_ios_fw_version')
+        self.os_ios_fw_version = attributes[:'os_ios_fw_version']
+      end
+
+      if attributes.key?(:'memory_size_type')
+        self.memory_size_type = attributes[:'memory_size_type']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'approval_status')
+        self.approval_status = attributes[:'approval_status']
+      end
+
+      if attributes.key?(:'critical_asset')
+        self.critical_asset = attributes[:'critical_asset']
+      end
+
+      if attributes.key?(:'public_facing_fqdn')
+        self.public_facing_fqdn = attributes[:'public_facing_fqdn']
+      end
+
+      if attributes.key?(:'public_facing_ip_address')
+        self.public_facing_ip_address = attributes[:'public_facing_ip_address']
+      end
+
+      if attributes.key?(:'public_facing_urls')
+        self.public_facing_urls = attributes[:'public_facing_urls']
+      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 &&
+          system_id == o.system_id &&
+          hardware_id == o.hardware_id &&
+          asset_name == o.asset_name &&
+          component_type == o.component_type &&
+          nickname == o.nickname &&
+          asset_ip_address == o.asset_ip_address &&
+          public_facing == o.public_facing &&
+          virtual_asset == o.virtual_asset &&
+          manufacturer == o.manufacturer &&
+          model_number == o.model_number &&
+          serial_number == o.serial_number &&
+          os_ios_fw_version == o.os_ios_fw_version &&
+          memory_size_type == o.memory_size_type &&
+          location == o.location &&
+          approval_status == o.approval_status &&
+          critical_asset == o.critical_asset &&
+          public_facing_fqdn == o.public_facing_fqdn &&
+          public_facing_ip_address == o.public_facing_ip_address &&
+          public_facing_urls == o.public_facing_urls
+    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
+      [system_id, hardware_id, asset_name, component_type, nickname, asset_ip_address, public_facing, virtual_asset, manufacturer, model_number, serial_number, os_ios_fw_version, memory_size_type, location, approval_status, critical_asset, public_facing_fqdn, public_facing_ip_address, public_facing_urls].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/{success200_response.rb → hw_baseline_response_post_put.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
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module EmassClient
-  class Success200Response
+  class HwBaselineResponsePostPut
     attr_accessor :meta
 
     attr_accessor :data
@@ -27,16 +27,21 @@ 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.
     def self.openapi_types
       {
         :'meta' => :'Response200',
-        :'data' => :'Array<Success200ResponseDataInner>'
+        :'data' => :'Array<HwBaselineResponsePostPutDataInner>'
       }
     end
 
@@ -50,13 +55,14 @@ module EmassClient
     # @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::Success200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::HwBaselineResponsePostPut` 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 (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::Success200Response`. 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::HwBaselineResponsePostPut`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -170,7 +176,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