emass_client 3.10.1 → 3.22.0

data/lib/emass_client/api/milestones_api.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` endpoint to register the client certificate.</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.10
-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.0.0-SNAPSHOT
+Generator version: 7.12.0-SNAPSHOT
 
 =end
 
@@ -23,7 +23,7 @@ module EmassClient
     # Adds a milestone for given `systemId` and `poamId` path parameters  **Request Body Required Fields** - `description` - `scheduledCompletionDate`
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
-    # @param request_body [Array<Object>] Add milestones to an existing system poam
+    # @param request_body [Array<Object>] Example request body for adding milestones to an existing System (systemId) POA&amp;M (poamId)
     # @param [Hash] opts the optional parameters
     # @return [MilestoneResponsePost]
     def add_milestone_by_system_id_and_poam_id(system_id, poam_id, request_body, opts = {})
@@ -35,7 +35,7 @@ module EmassClient
     # Adds a milestone for given &#x60;systemId&#x60; and &#x60;poamId&#x60; path parameters  **Request Body Required Fields** - &#x60;description&#x60; - &#x60;scheduledCompletionDate&#x60;
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
-    # @param request_body [Array<Object>] Add milestones to an existing system poam
+    # @param request_body [Array<Object>] Example request body for adding milestones to an existing System (systemId) POA&amp;M (poamId)
     # @param [Hash] opts the optional parameters
     # @return [Array<(MilestoneResponsePost, Integer, Hash)>] MilestoneResponsePost data, response status code and response headers
     def add_milestone_by_system_id_and_poam_id_with_http_info(system_id, poam_id, request_body, opts = {})
@@ -63,7 +63,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -100,24 +100,24 @@ module EmassClient
     end
 
     # Remove milestones in a system for one or many POA&M items
-    # Remove the POA&M matching `systemId` and `poamId` for path parameters and `milstoneId` provide in the Requst Body  **Notes**<br> To delete a milestone the record must be inactive by having the field isActive set to false (`isActive=false`).
+    # Remove the POA&M matching `systemId` and `poamId` for path parameters and `milstoneId` provide in the Request Body  **NOTE**<br> To delete a milestone the record must be inactive by having the field isActive set to false (`isActive=false`).
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
     # @param milestones_request_delete_body_inner [Array<MilestonesRequestDeleteBodyInner>] Delete the given Milestone Id
     # @param [Hash] opts the optional parameters
-    # @return [MilestonesPutPostDelete]
+    # @return [MilestoneResponseDelete]
     def delete_milestone(system_id, poam_id, milestones_request_delete_body_inner, opts = {})
       data, _status_code, _headers = delete_milestone_with_http_info(system_id, poam_id, milestones_request_delete_body_inner, opts)
       data
     end
 
     # Remove milestones in a system for one or many POA&amp;M items
-    # Remove the POA&amp;M matching &#x60;systemId&#x60; and &#x60;poamId&#x60; for path parameters and &#x60;milstoneId&#x60; provide in the Requst Body  **Notes**&lt;br&gt; To delete a milestone the record must be inactive by having the field isActive set to false (&#x60;isActive&#x3D;false&#x60;).
+    # Remove the POA&amp;M matching &#x60;systemId&#x60; and &#x60;poamId&#x60; for path parameters and &#x60;milstoneId&#x60; provide in the Request Body  **NOTE**&lt;br&gt; To delete a milestone the record must be inactive by having the field isActive set to false (&#x60;isActive&#x3D;false&#x60;).
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
     # @param milestones_request_delete_body_inner [Array<MilestonesRequestDeleteBodyInner>] Delete the given Milestone Id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(MilestonesPutPostDelete, Integer, Hash)>] MilestonesPutPostDelete data, response status code and response headers
+    # @return [Array<(MilestoneResponseDelete, Integer, Hash)>] MilestoneResponseDelete data, response status code and response headers
     def delete_milestone_with_http_info(system_id, poam_id, milestones_request_delete_body_inner, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MilestonesApi.delete_milestone ...'
@@ -143,7 +143,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -157,7 +157,7 @@ module EmassClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(milestones_request_delete_body_inner)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'MilestonesPutPostDelete'
+      return_type = opts[:debug_return_type] || 'MilestoneResponseDelete'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
@@ -223,7 +223,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -298,7 +298,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -333,7 +333,7 @@ module EmassClient
     # Updates a milestone for given `systemId` and `poamId` path parameters  **Request Body Required Fields** - `milestoneId` - `description` - `scheduledCompletionDate`
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
-    # @param request_body [Array<Object>] Update milestones for an existing system poam
+    # @param request_body [Array<Object>] Example request body for updating milestones (milestoneId) of an existing System (systemId) POA&amp;M (poamId)
     # @param [Hash] opts the optional parameters
     # @return [MilestoneResponsePut]
     def update_milestone_by_system_id_and_poam_id(system_id, poam_id, request_body, opts = {})
@@ -345,7 +345,7 @@ module EmassClient
     # Updates a milestone for given &#x60;systemId&#x60; and &#x60;poamId&#x60; path parameters  **Request Body Required Fields** - &#x60;milestoneId&#x60; - &#x60;description&#x60; - &#x60;scheduledCompletionDate&#x60;
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param poam_id [Integer] **POA&amp;M Id**: The unique POA&amp;M record identifier.
-    # @param request_body [Array<Object>] Update milestones for an existing system poam
+    # @param request_body [Array<Object>] Example request body for updating milestones (milestoneId) of an existing System (systemId) POA&amp;M (poamId)
     # @param [Hash] opts the optional parameters
     # @return [Array<(MilestoneResponsePut, Integer, Hash)>] MilestoneResponsePut data, response status code and response headers
     def update_milestone_by_system_id_and_poam_id_with_http_info(system_id, poam_id, request_body, opts = {})
@@ -373,7 +373,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?

data/lib/emass_client/api/organization_migration_status_dashboard_api.rb

@@ -0,0 +1,95 @@
+=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 'cgi'
+
+module EmassClient
+  class OrganizationMigrationStatusDashboardApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Organization Migration Status Summary
+    # Get organization migration status summary dashboard information.
+    # @param org_id [Integer] **Organization Id**: The unique organization identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data.  (default to false)
+    # @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0.  (default to 0)
+    # @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page.  (default to 20000)
+    # @return [GetSystemStatusDetails200Response]
+    def get_organization_migration_status_summary(org_id, opts = {})
+      data, _status_code, _headers = get_organization_migration_status_summary_with_http_info(org_id, opts)
+      data
+    end
+
+    # Organization Migration Status Summary
+    # Get organization migration status summary dashboard information.
+    # @param org_id [Integer] **Organization Id**: The unique organization identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data.  (default to false)
+    # @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0.  (default to 0)
+    # @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page.  (default to 20000)
+    # @return [Array<(GetSystemStatusDetails200Response, Integer, Hash)>] GetSystemStatusDetails200Response data, response status code and response headers
+    def get_organization_migration_status_summary_with_http_info(org_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationMigrationStatusDashboardApi.get_organization_migration_status_summary ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling OrganizationMigrationStatusDashboardApi.get_organization_migration_status_summary"
+      end
+      # resource path
+      local_var_path = '/api/dashboards/organization-migration-status-summary'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'orgId'] = org_id
+      query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
+      query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSystemStatusDetails200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationMigrationStatusDashboardApi.get_organization_migration_status_summary",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationMigrationStatusDashboardApi#get_organization_migration_status_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/emass_client/api/pac_api.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` endpoint to register the client certificate.</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.10
-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.0.0-SNAPSHOT
+Generator version: 7.12.0-SNAPSHOT
 
 =end
 
@@ -19,10 +19,10 @@ module EmassClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Submit system package for review
-    # Adds a Package Approval Chain (PAC) for given `systemId` path parameter
+    # Initiate system workflow for review
+    # Adds a Package Approval Chain (PAC) for given `systemId` path parameter  **Request Body Required Fields** - `workflow` - `name` - `comments`
     # @param system_id [Integer] **System Id**: The unique system record identifier.
-    # @param request_body [Array<Object>] Add system package to PAC for review
+    # @param request_body [Array<Object>] Example request body for adding system package to PAC for review
     # @param [Hash] opts the optional parameters
     # @return [PacResponsePost]
     def add_system_pac(system_id, request_body, opts = {})
@@ -30,10 +30,10 @@ module EmassClient
       data
     end
 
-    # Submit system package for review
-    # Adds a Package Approval Chain (PAC) for given &#x60;systemId&#x60; path parameter
+    # Initiate system workflow for review
+    # Adds a Package Approval Chain (PAC) for given &#x60;systemId&#x60; path parameter  **Request Body Required Fields** - &#x60;workflow&#x60; - &#x60;name&#x60; - &#x60;comments&#x60;
     # @param system_id [Integer] **System Id**: The unique system record identifier.
-    # @param request_body [Array<Object>] Add system package to PAC for review
+    # @param request_body [Array<Object>] Example request body for adding system package to PAC for review
     # @param [Hash] opts the optional parameters
     # @return [Array<(PacResponsePost, Integer, Hash)>] PacResponsePost data, response status code and response headers
     def add_system_pac_with_http_info(system_id, request_body, opts = {})
@@ -57,7 +57,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -93,8 +93,8 @@ module EmassClient
       return data, status_code, headers
     end
 
-    # Get location of system package in PAC
-    # Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter
+    # Get status of active workflows in a system
+    # Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter  **NOTES:** - If the indicated system has any active workflows, the response will include information   such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param [Hash] opts the optional parameters
     # @return [PacResponseGet]
@@ -103,8 +103,8 @@ module EmassClient
       data
     end
 
-    # Get location of system package in PAC
-    # Returns the location of a system&#39;s package in the Package Approval Chain (PAC) for matching &#x60;systemId&#x60; path parameter
+    # Get status of active workflows in a system
+    # Returns the location of a system&#39;s package in the Package Approval Chain (PAC) for matching &#x60;systemId&#x60; path parameter  **NOTES:** - If the indicated system has any active workflows, the response will include information   such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.
     # @param system_id [Integer] **System Id**: The unique system record identifier.
     # @param [Hash] opts the optional parameters
     # @return [Array<(PacResponseGet, Integer, Hash)>] PacResponseGet data, response status code and response headers
@@ -125,7 +125,7 @@ module EmassClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}