emasser 1.0.0

data/emass_client/ruby_client/docs/CacGet.md

@@ -0,0 +1,13 @@
+# SwaggerClient::CacGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**system_id** | **Integer** | [Required] Unique eMASS system identifier. | [optional] 
+**control_acronym** | **String** | [Required] System acronym name. | [optional] 
+**compliance_status** | **String** | [Read-only] Compliance status of the control. | [optional] 
+**current_stage_name** | **String** | [Read-Only] Role in current stage. | [optional] 
+**current_stage** | **Integer** | [Read-Only] Current step in the Control Approval Chain. | [optional] 
+**total_stages** | **Integer** | [Read-Only] Total number of steps in Control Approval Chain. | [optional] 
+**comments** | **String** | [Conditional] Control Approval Chain comments - 2000 Characters. | [optional] 
+

data/emass_client/ruby_client/docs/CacRequestPostBody.md

@@ -0,0 +1,8 @@
+# SwaggerClient::CacRequestPostBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**control_acronym** | **String** | [Required] System acronym name. | [optional] 
+**comments** | **String** | [Conditional] Control Approval Chain comments - 2000 Characters. | [optional] 
+

data/emass_client/ruby_client/docs/CacResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::CacResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<CacGet>**](CacGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/CacResponsePost.md

@@ -0,0 +1,8 @@
+# SwaggerClient::CacResponsePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<CacResponsePostData>**](CacResponsePostData.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/CacResponsePostData.md

@@ -0,0 +1,9 @@
+# SwaggerClient::CacResponsePostData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**control_acronym** | **String** | [Required] System acronym name. | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+**system_id** | **Integer** |  | [optional] 
+

data/emass_client/ruby_client/docs/CmmcGet.md

@@ -0,0 +1,19 @@
+# SwaggerClient::CmmcGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | **String** | [Read-Only] Indicates the action that should be taken on the assessment record since the provided sinceDate. | [optional] 
+**hq_organization_name** | **String** | [Read-Only] The name of the DIB Company. | [optional] 
+**duns** | **String** | [Read-Only] The Data Universal Numbering System (DUNS) number. | [optional] 
+**unique_entity_identifier** | **String** | [Read-Only] The Unique Entity Identifier assigned to the DIB Company. | [optional] 
+**cage_codes** | **String** | [Read-Only] The five position code(s) associated with the Organization Seeking Certification (OSC). | [optional] 
+**osc_name** | **String** | [Read-Only] The name of the Organization Seeking Certification. | [optional] 
+**scope** | **String** | [Read-Only] The scope of the OSC assessment. | [optional] 
+**scope_description** | **String** | [Read-Only] Brief description of the scope of the OSC assessment | [optional] 
+**awarded_cmmc_level** | **String** | [Read-Only] The CMMC award level. | [optional] 
+**expiration_date** | **Integer** | [Read-Only] Expiration date of the awarded CMMC certification. | [optional] 
+**certificate_id** | **String** | [Read-Only] Unique identifier for the assessment/certificate. | [optional] 
+**model_version** | **String** | [Read-Only] Version of the CMMC Model used as part of the assessment. | [optional] 
+**ssps** | [**Array<Ssps>**](Ssps.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/CmmcResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::CmmcResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<CmmcGet>**](CmmcGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/ConnectivityCcsd.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ConnectivityCcsd
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ccsd_number** | **String** | [Read-Only] Identifier for specific connections to the system. | [optional] 
+**connectivity** | **String** | [Read-Only] Choose connection type for the system. | [optional] 
+

data/emass_client/ruby_client/docs/ControlsApi.md

@@ -0,0 +1,140 @@
+# SwaggerClient::ControlsApi
+
+All URIs are relative to *http://localhost:4010*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_system_controls**](ControlsApi.md#get_system_controls) | **GET** /api/systems/{systemId}/controls | Get control information in a system for one or many controls
+[**update_control_by_system_id**](ControlsApi.md#update_control_by_system_id) | **PUT** /api/systems/{systemId}/controls | Update control information in a system for one or many controls
+
+# **get_system_controls**
+> ControlsResponseGet get_system_controls(system_id, opts)
+
+Get control information in a system for one or many controls
+
+Returns system control information for matching `systemId` path parameter
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ControlsApi.new
+system_id = 56 # Integer | **System Id**: The unique system record identifier.
+opts = { 
+  acronyms: 'PM-6' # String | **Acronym**: The system acronym(s) being queried (single value or comma delimited values).
+}
+
+begin
+  #Get control information in a system for one or many controls
+  result = api_instance.get_system_controls(system_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ControlsApi->get_system_controls: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **system_id** | **Integer**| **System Id**: The unique system record identifier. | 
+ **acronyms** | **String**| **Acronym**: The system acronym(s) being queried (single value or comma delimited values). | [optional] [default to PM-6]
+
+### Return type
+
+[**ControlsResponseGet**](ControlsResponseGet.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_control_by_system_id**
+> ControlsResponsePut update_control_by_system_id(bodysystem_id)
+
+Update control information in a system for one or many controls
+
+ Update a Control for given `systemId`<br>  **Request Body Required Fields** - `acronym` - `responsibleEntities` - `controlDesignation` - `estimatedCompletionDate` - `implementationNarrative`  The following optional fields are required based on the Implementation Status `implementationStatus` value<br> | Value                    | Required Fields |--------------------------|--------------------------------------------------- | Planned  or Implemented  | `estimatedCompletionDate`, `responsibleEntities`, `slcmCriticality`, `slcmFrequency`, `slcmMethod`, `slcmReporting`, `slcmTracking`, `slcmComments` | Not Applicable           | `naJustification`, `responsibleEntities` | Manually Inherited       | `commonControlProvider`, `estimatedCompletionDate`, `responsibleEntities`, `slcmCriticality`, `slcmFrequency`, `slcmMethod`, `slcmReporting`, `slcmTracking`, `slcmComments`  If the Implementation Status `implementationStatus` value is \"Inherited\", only the following fields can be updated:   - `controlDesignation`   - `commonnControlProvider`
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::ControlsApi.new
+body = SwaggerClient::ControlsRequestPutBody.new # ControlsRequestPutBody | Update an existing control by Id
+system_id = 56 # Integer | **System Id**: The unique system record identifier.
+
+
+begin
+  #Update control information in a system for one or many controls
+  result = api_instance.update_control_by_system_id(bodysystem_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ControlsApi->update_control_by_system_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ControlsRequestPutBody**](ControlsRequestPutBody.md)| Update an existing control by Id | 
+ **system_id** | **Integer**| **System Id**: The unique system record identifier. | 
+
+### Return type
+
+[**ControlsResponsePut**](ControlsResponsePut.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/emass_client/ruby_client/docs/ControlsGet.md

@@ -0,0 +1,36 @@
+# SwaggerClient::ControlsGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**system_id** | **Integer** | [Required] Unique system record identifier. | [optional] 
+**name** | **String** | [Read-only] Name of the system record. | [optional] 
+**acronym** | **String** | [Required] Acronym of the system record. | [optional] 
+**ccis** | **String** | [Read-only] Comma separated list of CCIs associated with the control. | [optional] 
+**is_inherited** | **BOOLEAN** | [Read-only] Indicates whether a control is inherited. | [optional] 
+**modified_by_overlays** | **String** | [Read-only] List of overlays that affect the control. | [optional] 
+**included_status** | **String** | [Read-only] Indicates the manner by which a control was included in the system’s categorization. | [optional] 
+**compliance_status** | **String** | [Read-only] Compliance of the control. | [optional] 
+**responsible_entities** | **String** | [Required] Include written description of Responsible Entities that are responsible for the Security Control. Character Limit = 2,000. | [optional] 
+**implementation_status** | **String** | [Optional] Implementation Status of the Security Control for the information system. | [optional] 
+**common_control_provider** | **String** | [Conditional] Indicate the type of Common Control Provider for an “Inherited” Security Control. | [optional] 
+**na_justification** | **String** | [Conditional] Provide justification for Security Controls deemed Not Applicable to the system. | [optional] 
+**control_designation** | **String** | [Required] Control designations | [optional] 
+**estimated_completion_date** | **Integer** | [Required] Field is required for Implementation Plan. | [optional] 
+**implementation_narrative** | **String** | [Required] Includes security control comments. Character Limit = 2,000. | [optional] 
+**slcm_criticality** | **String** | [Conditional] Criticality of Security Control regarding SLCM. Character Limit = 2,000. | [optional] 
+**slcm_frequency** | **String** | [Conditional] SLCM frequency | [optional] 
+**slcm_method** | **String** | [Conditional] SLCM method utilized | [optional] 
+**slcm_reporting** | **String** | [Conditional] Method for reporting Security Control for SLCM. Character Limit = 2,000. | [optional] 
+**slcm_tracking** | **String** | [Conditional] How Non-Compliant Security Controls will be tracked for SLCM. Character Limit = 2,000. | [optional] 
+**slcm_comments** | **String** | [Conditional] Additional comments for Security Control regarding SLCM. Character Limit = 4,000. | [optional] 
+**severity** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**vulnerabilty_summary** | **String** | [Optional] Include vulnerability summary. Character Limit = 2,000. | [optional] 
+**recommendations** | **String** | [Optional] Include recommendations. Character Limit = 2,000. | [optional] 
+**relevance_of_threat** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**likelihood** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**impact** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**impact_description** | **String** | [Optional] Include description of Security Control’s impact. | [optional] 
+**residual_risk_level** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**test_method** | **String** | [Optional] Identifies the assessment method / combination that will determine if the security requirements are implemented correctly. | [optional] 
+

data/emass_client/ruby_client/docs/ControlsPut.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ControlsPut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acronym** | **String** | Acronym of the system record. | [optional] 
+**success** | **BOOLEAN** | Indicates if operations result (success/fail) | [optional] 
+**system_id** | **Integer** | The system identifier for the system being updated. | [optional] 
+

data/emass_client/ruby_client/docs/ControlsRequestPutBody.md

@@ -0,0 +1,29 @@
+# SwaggerClient::ControlsRequestPutBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acronym** | **String** | [Required] Required to match the NIST SP 800-53 Revision 4. | 
+**responsible_entities** | **String** | [Required] Include written description of Responsible Entities that are responsible for the Security Control. Character Limit = 2,000. | 
+**implementation_status** | **String** | [Optional] Implementation Status of the Security Control for the information system. | [optional] 
+**common_control_provider** | **String** | [Conditional] Indicate the type of Common Control Provider for an “Inherited” Security Control. | [optional] 
+**na_justification** | **String** | [Conditional] Provide justification for Security Controls deemed Not Applicable to the system. | [optional] 
+**control_designation** | **String** | [Required] Control designations | 
+**test_method** | **String** | [Optional] Identifies the assessment method / combination that will determine if the security requirements are implemented correctly. | [optional] 
+**estimated_completion_date** | **Integer** | [Required] Field is required for Implementation Plan. | 
+**implementation_narrative** | **String** | [Required] Includes security control comments. Character Limit = 2,000. | 
+**slcm_criticality** | **String** | [Conditional] Criticality of Security Control regarding SLCM. Character Limit = 2,000. | [optional] 
+**slcm_frequency** | **String** | [Conditional] SLCM frequency | [optional] 
+**slcm_method** | **String** | [Conditional] SLCM method utilized | [optional] 
+**slcm_reporting** | **String** | [Conditional] Method for reporting Security Control for SLCM. Character Limit = 2,000. | [optional] 
+**slcm_tracking** | **String** | [Conditional] How Non-Compliant Security Controls will be tracked for SLCM. Character Limit = 2,000. | [optional] 
+**slcm_comments** | **String** | [Conditional] Additional comments for Security Control regarding SLCM. Character Limit = 4,000. | [optional] 
+**severity** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**vulnerabilty_summary** | **String** | [Optional] Include vulnerability summary. Character Limit = 2,000. | [optional] 
+**recommendations** | **String** | [Optional] Include recommendations. Character Limit = 2,000. | [optional] 
+**relevance_of_threat** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**likelihood** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**impact** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+**impact_description** | **String** | [Optional] Include description of Security Control's impact. | [optional] 
+**residual_risk_level** | **String** | [Optional] Values include the following options (Very Low, Low, Moderate,High,Very High) | [optional] 
+

data/emass_client/ruby_client/docs/ControlsResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ControlsResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<ControlsGet>**](ControlsGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/ControlsResponsePut.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ControlsResponsePut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<ControlsPut>**](ControlsPut.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/DefinitionTransitions.md

@@ -0,0 +1,9 @@
+# SwaggerClient::DefinitionTransitions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_stage** | **String** | [Read-Only] The landing stage that is active after performing a transition. | [optional] 
+**description** | **String** | [Read-Only] Description of the workflow or the stage transition. For stage transitions, this matches the action dropdown that appears for PAC users. | [optional] 
+**roles** | **Array<String>** |  | [optional] 
+

data/emass_client/ruby_client/docs/DeleteMilestone.md

@@ -0,0 +1,7 @@
+# SwaggerClient::DeleteMilestone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**milestone_id** | **Integer** | [Required] Unique item identifier | 
+

data/emass_client/ruby_client/docs/DeletePoam.md

@@ -0,0 +1,7 @@
+# SwaggerClient::DeletePoam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**poam_id** | **Integer** | [Required] Unique item identifier | 
+

data/emass_client/ruby_client/docs/Empty200Response.md

@@ -0,0 +1,6 @@
+# SwaggerClient::Empty200Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/emass_client/ruby_client/docs/Error.md

@@ -0,0 +1,8 @@
+# SwaggerClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**message** | **String** |  | 
+

data/emass_client/ruby_client/docs/InstancesTransitions.md

@@ -0,0 +1,12 @@
+# SwaggerClient::InstancesTransitions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**comments** | **String** | [Read-Only] Comments entered by the user when performing the transition. | [optional] 
+**created_by** | **String** | [Read-Only] User that performed the workflow transition. | [optional] 
+**created_date** | **Integer** | [Read-Only] Date the workflow instance or the workflow transition was created. | [optional] 
+**description** | **String** | [Read-Only] Description of the stage transition. This matches the action dropdown that appears for PAC users. | [optional] 
+**end_stage** | **String** | [Read-Only] The landing stage that is active after performing a transition. | [optional] 
+**start_stage** | **String** | [Read-Only] The beginning stage that is active before performing a transition. | [optional] 
+

data/emass_client/ruby_client/docs/MilestoneResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::MilestoneResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<MilestonesGet>**](MilestonesGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/MilestoneResponsePost.md

@@ -0,0 +1,8 @@
+# SwaggerClient::MilestoneResponsePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<MilestonesPost>**](MilestonesPost.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/MilestoneResponsePut.md

@@ -0,0 +1,8 @@
+# SwaggerClient::MilestoneResponsePut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<MilestonesPut>**](MilestonesPut.md) |  | [optional] 
+