cmv4-openapi-client 1.0.3

data/docs/GeneralDefinitionApi.md

@@ -0,0 +1,240 @@
+# CMV4APIClient::GeneralDefinitionApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**definition_get**](GeneralDefinitionApi.md#definition_get) | **GET** /definition/enterprisedefinition | Get Enterprise Definition
+[**definition_get_enterprise_configuration**](GeneralDefinitionApi.md#definition_get_enterprise_configuration) | **GET** /definition/enterpriseconfiguration | Get Enterprise Configuration
+[**definition_get_entity**](GeneralDefinitionApi.md#definition_get_entity) | **GET** /definition/entity/{entityAlias} | Get Entity Definition
+[**definition_get_relationship**](GeneralDefinitionApi.md#definition_get_relationship) | **GET** /definition/relationship/{relationshipAlias} | Get Relationship Definition
+[**definition_get_stereotypes**](GeneralDefinitionApi.md#definition_get_stereotypes) | **GET** /definition/stereotypes/{scope} | Get Stereotypes By Scope
+
+
+
+## definition_get
+
+> ConcreteEnterpriseDefinition definition_get
+
+Get Enterprise Definition
+
+Gets the Enterprise Definition object
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDefinitionApi.new
+
+begin
+  #Get Enterprise Definition
+  result = api_instance.definition_get
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDefinitionApi->definition_get: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConcreteEnterpriseDefinition**](ConcreteEnterpriseDefinition.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## definition_get_enterprise_configuration
+
+> EnterpriseConfigurationModified definition_get_enterprise_configuration
+
+Get Enterprise Configuration
+
+Gets the Enterprise Configuration object
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDefinitionApi.new
+
+begin
+  #Get Enterprise Configuration
+  result = api_instance.definition_get_enterprise_configuration
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDefinitionApi->definition_get_enterprise_configuration: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**EnterpriseConfigurationModified**](EnterpriseConfigurationModified.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## definition_get_entity
+
+> EntityDefinition definition_get_entity(entity_alias)
+
+Get Entity Definition
+
+Gets an entities definition
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDefinitionApi.new
+entity_alias = 'entity_alias_example' # String |
+
+begin
+  #Get Entity Definition
+  result = api_instance.definition_get_entity(entity_alias)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDefinitionApi->definition_get_entity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_alias** | **String**|  |
+
+### Return type
+
+[**EntityDefinition**](EntityDefinition.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## definition_get_relationship
+
+> RelationshipDefinition definition_get_relationship(relationship_alias)
+
+Get Relationship Definition
+
+Gets a relationships definition
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDefinitionApi.new
+relationship_alias = 'relationship_alias_example' # String |
+
+begin
+  #Get Relationship Definition
+  result = api_instance.definition_get_relationship(relationship_alias)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDefinitionApi->definition_get_relationship: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **relationship_alias** | **String**|  |
+
+### Return type
+
+[**RelationshipDefinition**](RelationshipDefinition.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## definition_get_stereotypes
+
+> Array<Stereotype> definition_get_stereotypes(scope)
+
+Get Stereotypes By Scope
+
+Gets a list of Stereotypes by a particular scope
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDefinitionApi.new
+scope = CMV4APIClient::StereotypeScope.new # StereotypeScope |
+
+begin
+  #Get Stereotypes By Scope
+  result = api_instance.definition_get_stereotypes(scope)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDefinitionApi->definition_get_stereotypes: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **scope** | [**StereotypeScope**](.md)|  |
+
+### Return type
+
+[**Array<Stereotype>**](Stereotype.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GeneralDiffApi.md

@@ -0,0 +1,64 @@
+# CMV4APIClient::GeneralDiffApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**diff_get**](GeneralDiffApi.md#diff_get) | **GET** /diff/{entityAlias}/{id} | Get Entity Changes
+
+
+
+## diff_get
+
+> Array<ChangeLog> diff_get(entity_alias, id, opts)
+
+Get Entity Changes
+
+Gets the changes performed on a particular entity<br/><span style=\"font-weight: bold;color: red\">The HistorySearch feature toggle is required to use this route</span>
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralDiffApi.new
+entity_alias = 'entity_alias_example' # String | 
+id = 56 # Integer | 
+opts = {
+  page: 1, # Integer | 
+  page_size: 50 # Integer | 
+}
+
+begin
+  #Get Entity Changes
+  result = api_instance.diff_get(entity_alias, id, opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralDiffApi->diff_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_alias** | **String**|  | 
+ **id** | **Integer**|  | 
+ **page** | **Integer**|  | [optional] [default to 1]
+ **page_size** | **Integer**|  | [optional] [default to 50]
+
+### Return type
+
+[**Array&lt;ChangeLog&gt;**](ChangeLog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GeneralFeaturesApi.md

@@ -0,0 +1,96 @@
+# CMV4APIClient::GeneralFeaturesApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**features_get_active_features**](GeneralFeaturesApi.md#features_get_active_features) | **GET** /features/active | Get Active Features
+[**features_get_all_features**](GeneralFeaturesApi.md#features_get_all_features) | **GET** /features | Get All Features
+
+
+
+## features_get_active_features
+
+> Array<String> features_get_active_features
+
+Get Active Features
+
+Gets the features that are active within the system
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralFeaturesApi.new
+
+begin
+  #Get Active Features
+  result = api_instance.features_get_active_features
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralFeaturesApi->features_get_active_features: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## features_get_all_features
+
+> Array<String> features_get_all_features
+
+Get All Features
+
+Gets all available features within the system
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralFeaturesApi.new
+
+begin
+  #Get All Features
+  result = api_instance.features_get_all_features
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralFeaturesApi->features_get_all_features: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GeneralHistorySearchApi.md

@@ -0,0 +1,56 @@
+# CMV4APIClient::GeneralHistorySearchApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**history_search_get**](GeneralHistorySearchApi.md#history_search_get) | **POST** /historysearch | Get History Search Data
+
+
+
+## history_search_get
+
+> Action history_search_get(search_request)
+
+Get History Search Data
+
+Gets the history search data based on the passed request<br/><span style=\"font-weight: bold;color: red\">The HistorySearch feature toggle is required to use this route</span>
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralHistorySearchApi.new
+search_request = CMV4APIClient::SearchRequest.new # SearchRequest |
+
+begin
+  #Get History Search Data
+  result = api_instance.history_search_get(search_request)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralHistorySearchApi->history_search_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_request** | [**SearchRequest**](SearchRequest.md)|  |
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json+action, application/json+correspondence, application/json+document, application/json+event, application/json+organisation, application/json+project, application/json+property, application/json+stakeholder, application/json+team, application/json+user
+

data/docs/GeneralOrganisationalSettingsApi.md

@@ -0,0 +1,56 @@
+# CMV4APIClient::GeneralOrganisationalSettingsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**organisational_settings_get**](GeneralOrganisationalSettingsApi.md#organisational_settings_get) | **GET** /organisationalsettings/{category} | Get Organisational Settings
+
+
+
+## organisational_settings_get
+
+> File organisational_settings_get(category)
+
+Get Organisational Settings
+
+Gets a specific type of organisational setting
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralOrganisationalSettingsApi.new
+category = 'category_example' # String | 
+
+begin
+  #Get Organisational Settings
+  result = api_instance.organisational_settings_get(category)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralOrganisationalSettingsApi->organisational_settings_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category** | **String**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream
+

data/docs/GeneralQueryApi.md

@@ -0,0 +1,56 @@
+# CMV4APIClient::GeneralQueryApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**query_get**](GeneralQueryApi.md#query_get) | **POST** /query | Query Entity
+
+
+
+## query_get
+
+> Action query_get(query_request)
+
+Query Entity
+
+Gets an entity based on the passed request
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralQueryApi.new
+query_request = CMV4APIClient::QueryRequest.new # QueryRequest |
+
+begin
+  #Query Entity
+  result = api_instance.query_get(query_request)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralQueryApi->query_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_request** | [**QueryRequest**](QueryRequest.md)|  |
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json+action, application/json+correspondence, application/json+document, application/json+event, application/json+organisation, application/json+project, application/json+property, application/json+stakeholder, application/json+team, application/json+user, application/json+ActionDocument, application/json+actionProjectRelationship, application/json+assignedByaction, application/json+assignedToaction, application/json+correspondenceProjectRelationship, application/json+CorrespondenceToStakeholder, application/json+CorrespondenceToUser, application/json+documentProjectRelationship, application/json+DocumentStakeholder, application/json+DocumentUser, application/json+EventAction, application/json+EventDocument, application/json+eventorganisation, application/json+eventProjectRelationship, application/json+EventUser, application/json+membership, application/json+organisationProjectRelationship, application/json+propertyAction, application/json+propertyDocument, application/json+propertyEvent, application/json+propertyorganisation, application/json+propertyProjectRelationship, application/json+propertyUser, application/json+sar, application/json+ser, application/json+spr, application/json+stakeholderorganisation, application/json+stakeholderProjectRelationship, application/json+teamProjectRelationship, application/json+userStakeholder
+

data/docs/GeneralSearchApi.md

@@ -0,0 +1,104 @@
+# CMV4APIClient::GeneralSearchApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search_search**](GeneralSearchApi.md#search_search) | **POST** /search | Get Search Data
+[**search_search_multi**](GeneralSearchApi.md#search_search_multi) | **POST** /search/multi | Perform Multiple Searches
+
+
+
+## search_search
+
+> Action search_search(search_request)
+
+Get Search Data
+
+Gets the search data based up on the passed request
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSearchApi.new
+search_request = CMV4APIClient::SearchRequest.new # SearchRequest |
+
+begin
+  #Get Search Data
+  result = api_instance.search_search(search_request)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSearchApi->search_search: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_request** | [**SearchRequest**](SearchRequest.md)|  |
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json+action, application/json+correspondence, application/json+document, application/json+event, application/json+organisation, application/json+project, application/json+property, application/json+stakeholder, application/json+team, application/json+user
+
+
+## search_search_multi
+
+> Action search_search_multi(search_request)
+
+Perform Multiple Searches
+
+Gets the search data for each request in the array
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSearchApi.new
+search_request = [CMV4APIClient::SearchRequest.new] # Array<SearchRequest> |
+
+begin
+  #Perform Multiple Searches
+  result = api_instance.search_search_multi(search_request)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSearchApi->search_search_multi: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_request** | [**Array&lt;SearchRequest&gt;**](SearchRequest.md)|  |
+
+### Return type
+
+[**Action**](Action.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json+action, application/json+correspondence, application/json+document, application/json+event, application/json+organisation, application/json+project, application/json+property, application/json+stakeholder, application/json+team, application/json+user
+