cmv4-openapi-client 1.0.3

data/docs/GeneralSecurityApi.md

@@ -0,0 +1,358 @@
+# CMV4APIClient::GeneralSecurityApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**security_controller_read_get_security_for_entity**](GeneralSecurityApi.md#security_controller_read_get_security_for_entity) | **GET** /security/entity/{alias}/{instanceId} | Get Entity Security
+[**security_controller_read_get_security_for_relationship**](GeneralSecurityApi.md#security_controller_read_get_security_for_relationship) | **GET** /security/relationship/{alias}/{instanceId} | Get Relationship Security
+[**security_controller_read_get_stereotypes_for_user**](GeneralSecurityApi.md#security_controller_read_get_stereotypes_for_user) | **GET** /security/user/stereotypes | Get User Stereotypes
+[**security_controller_write_assign_team_to_project**](GeneralSecurityApi.md#security_controller_write_assign_team_to_project) | **POST** /security/{teamId}/{projectId}/assignteamtoproject | Assign a team to a project
+[**security_controller_write_assign_user_to_team**](GeneralSecurityApi.md#security_controller_write_assign_user_to_team) | **POST** /security/{teamId}/assignusertoteam | Assign a user to a team
+[**security_controller_write_remove_team_from_project**](GeneralSecurityApi.md#security_controller_write_remove_team_from_project) | **POST** /security/{teamId}/{projectId}/removeteamfromproject | Remove Team to Project association
+[**security_controller_write_remove_user_from_team**](GeneralSecurityApi.md#security_controller_write_remove_user_from_team) | **POST** /security/{teamId}/{userId}/removeuserfromteam | Remove a user from a team
+
+
+
+## security_controller_read_get_security_for_entity
+
+> DomainObjectPermissions security_controller_read_get_security_for_entity(_alias, instance_id)
+
+Get Entity Security
+
+Gets the permissions for the logged in user on the requested entities
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+_alias = '_alias_example' # String | 
+instance_id = 56 # Integer | 
+
+begin
+  #Get Entity Security
+  result = api_instance.security_controller_read_get_security_for_entity(_alias, instance_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_read_get_security_for_entity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_alias** | **String**|  | 
+ **instance_id** | **Integer**|  | 
+
+### Return type
+
+[**DomainObjectPermissions**](DomainObjectPermissions.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## security_controller_read_get_security_for_relationship
+
+> DomainObjectPermissions security_controller_read_get_security_for_relationship(_alias, instance_id)
+
+Get Relationship Security
+
+Gets the permissions for the logged in user on the request relationship
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+_alias = '_alias_example' # String | 
+instance_id = 56 # Integer | 
+
+begin
+  #Get Relationship Security
+  result = api_instance.security_controller_read_get_security_for_relationship(_alias, instance_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_read_get_security_for_relationship: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_alias** | **String**|  | 
+ **instance_id** | **Integer**|  | 
+
+### Return type
+
+[**DomainObjectPermissions**](DomainObjectPermissions.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## security_controller_read_get_stereotypes_for_user
+
+> Array<Stereotype> security_controller_read_get_stereotypes_for_user(opts)
+
+Get User Stereotypes
+
+Gets stereotypes for either the passed or logged in user
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+opts = {
+  user_id: 56 # Integer | 
+}
+
+begin
+  #Get User Stereotypes
+  result = api_instance.security_controller_read_get_stereotypes_for_user(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_read_get_stereotypes_for_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**|  | [optional] 
+
+### Return type
+
+[**Array<Stereotype>**](Stereotype.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## security_controller_write_assign_team_to_project
+
+> File security_controller_write_assign_team_to_project(team_id, project_id)
+
+Assign a team to a project
+
+Creates an association between the team and project.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+team_id = 56 # Integer | 
+project_id = 56 # Integer | 
+
+begin
+  #Assign a team to a project
+  result = api_instance.security_controller_write_assign_team_to_project(team_id, project_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_write_assign_team_to_project: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **Integer**|  | 
+ **project_id** | **Integer**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream
+
+
+## security_controller_write_assign_user_to_team
+
+> File security_controller_write_assign_user_to_team(team_id, grant_team_membership_command_data)
+
+Assign a user to a team
+
+Creates an association between the user and team.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+team_id = 56 # Integer | 
+grant_team_membership_command_data = CMV4APIClient::GrantTeamMembershipCommandData.new # GrantTeamMembershipCommandData | 
+
+begin
+  #Assign a user to a team
+  result = api_instance.security_controller_write_assign_user_to_team(team_id, grant_team_membership_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_write_assign_user_to_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **Integer**|  | 
+ **grant_team_membership_command_data** | [**GrantTeamMembershipCommandData**](GrantTeamMembershipCommandData.md)|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/octet-stream
+
+
+## security_controller_write_remove_team_from_project
+
+> File security_controller_write_remove_team_from_project(team_id, project_id)
+
+Remove Team to Project association
+
+Removes the association between a Team and a Project.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+team_id = 56 # Integer | 
+project_id = 56 # Integer | 
+
+begin
+  #Remove Team to Project association
+  result = api_instance.security_controller_write_remove_team_from_project(team_id, project_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_write_remove_team_from_project: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **Integer**|  | 
+ **project_id** | **Integer**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream
+
+
+## security_controller_write_remove_user_from_team
+
+> File security_controller_write_remove_user_from_team(team_id, user_id)
+
+Remove a user from a team
+
+Removes the specified user from the team.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralSecurityApi.new
+team_id = 56 # Integer | 
+user_id = 56 # Integer | 
+
+begin
+  #Remove a user from a team
+  result = api_instance.security_controller_write_remove_user_from_team(team_id, user_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralSecurityApi->security_controller_write_remove_user_from_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **Integer**|  | 
+ **user_id** | **Integer**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream
+

data/docs/GeneralStorageApi.md

@@ -0,0 +1,110 @@
+# CMV4APIClient::GeneralStorageApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**storage_get_resource_information**](GeneralStorageApi.md#storage_get_resource_information) | **GET** /storage/request/download/{contentType}/{identifier} | Get Download Token
+[**storage_get_upload_data**](GeneralStorageApi.md#storage_get_upload_data) | **GET** /storage/request/upload/{contentType}/{filename}/{size} | Get Upload Token
+
+
+
+## storage_get_resource_information
+
+> Object storage_get_resource_information(content_type, identifier)
+
+Get Download Token
+
+Gets a download token used to download a file
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralStorageApi.new
+content_type = CMV4APIClient::StorageContentType.new # StorageContentType | 
+identifier = 'identifier_example' # String | 
+
+begin
+  #Get Download Token
+  result = api_instance.storage_get_resource_information(content_type, identifier)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralStorageApi->storage_get_resource_information: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_type** | [**StorageContentType**](.md)|  | 
+ **identifier** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## storage_get_upload_data
+
+> IUploadToken storage_get_upload_data(content_type, filename, size)
+
+Get Upload Token
+
+Gets an upload token used to upload a file
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralStorageApi.new
+content_type = CMV4APIClient::StorageContentType.new # StorageContentType | 
+filename = 'filename_example' # String | 
+size = 56 # Integer | 
+
+begin
+  #Get Upload Token
+  result = api_instance.storage_get_upload_data(content_type, filename, size)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralStorageApi->storage_get_upload_data: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_type** | [**StorageContentType**](.md)|  | 
+ **filename** | **String**|  | 
+ **size** | **Integer**|  | 
+
+### Return type
+
+[**IUploadToken**](IUploadToken.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GrantTeamMembershipCommandData.md

@@ -0,0 +1,19 @@
+# CMV4APIClient::GrantTeamMembershipCommandData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stereotype** | **String** |  | [optional] 
+**user_id** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::GrantTeamMembershipCommandData.new(stereotype: null,
+                                 user_id: null)
+```
+
+

data/docs/IEntityDefinition.md

@@ -0,0 +1,17 @@
+# CMV4APIClient::IEntityDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**require_project_association** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IEntityDefinition.new(require_project_association: null)
+```
+
+

data/docs/IEnumerableOfProjectOfObject.md

@@ -0,0 +1,21 @@
+# CMV4APIClient::IEnumerableOfProjectOfObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**project_group** | [**Array<ClassificationModel>**](ClassificationModel.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IEnumerableOfProjectOfObject.new(id: null,
+                                 name: null,
+                                 project_group: null)
+```
+
+

data/docs/IIdentityReference.md

@@ -0,0 +1,21 @@
+# CMV4APIClient::IIdentityReference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **Object** |  | [optional] 
+**identifier** | **Object** |  | [optional] 
+**identity_type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IIdentityReference.new(display_name: null,
+                                 identifier: null,
+                                 identity_type: null)
+```
+
+

data/docs/IKnowledgeBaseDataObjectDefinition.md

@@ -0,0 +1,23 @@
+# CMV4APIClient::IKnowledgeBaseDataObjectDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_alias** | **String** |  | [optional] 
+**field_definition_set** | [**Hash<String, IKnowledgeBaseFieldDefinition>**](IKnowledgeBaseFieldDefinition.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**plural_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IKnowledgeBaseDataObjectDefinition.new(_alias: null,
+                                 field_definition_set: null,
+                                 name: null,
+                                 plural_name: null)
+```
+
+

data/docs/IKnowledgeBaseFieldDefinition.md

@@ -0,0 +1,37 @@
+# CMV4APIClient::IKnowledgeBaseFieldDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional]
+**aggregate_parent** | **String** |  | [optional]
+**_alias** | **String** |  | [optional]
+**configuration** | [**object**](object.md) |  | [optional]
+**field_nature** | [**FieldNature**](FieldNature.md) |  | [optional]
+**name** | **String** |  | [optional]
+**read_only** | **Boolean** |  | [optional]
+**schema_name** | **String** |  | [optional]
+**security** | [**Array<FieldSecurity>**](FieldSecurity.md) |  | [optional]
+**type** | [**FieldType**](FieldType.md) |  | [optional]
+**validators** | [**Array<ValidatorDefinition>**](ValidatorDefinition.md) |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IKnowledgeBaseFieldDefinition.new(id: null,
+                                 aggregate_parent: null,
+                                 _alias: null,
+                                 configuration: null,
+                                 field_nature: null,
+                                 name: null,
+                                 read_only: null,
+                                 schema_name: null,
+                                 security: null,
+                                 type: null,
+                                 validators: null)
+```
+
+

data/docs/IKnowledgeBaseObjectDefinitionFeature.md

@@ -0,0 +1,19 @@
+# CMV4APIClient::IKnowledgeBaseObjectDefinitionFeature
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **Boolean** |  | [optional]
+**knowledge_base_object_definition** | [**IReadOnlyKnowledgeBaseObjectDefinition**](IReadOnlyKnowledgeBaseObjectDefinition.md) |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IKnowledgeBaseObjectDefinitionFeature.new(enabled: null,
+                                 knowledge_base_object_definition: null)
+```
+
+

data/docs/IModifier.md

@@ -0,0 +1,17 @@
+# CMV4APIClient::IModifier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IModifier.new(type: null)
+```
+
+

data/docs/IReadOnlyKnowledgeBaseObjectDefinition.md

@@ -0,0 +1,37 @@
+# CMV4APIClient::IReadOnlyKnowledgeBaseObjectDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**_alias** | **String** |  | [optional] 
+**all_field_definition_set** | [**Hash<String, IKnowledgeBaseFieldDefinition>**](IKnowledgeBaseFieldDefinition.md) |  | [optional] 
+**deleted_field_definition_set** | [**Hash<String, IKnowledgeBaseFieldDefinition>**](IKnowledgeBaseFieldDefinition.md) |  | [optional] 
+**features** | [**Hash<String, IKnowledgeBaseObjectDefinitionFeature>**](IKnowledgeBaseObjectDefinitionFeature.md) |  | [optional] 
+**field_definition_set** | [**Hash<String, IKnowledgeBaseFieldDefinition>**](IKnowledgeBaseFieldDefinition.md) |  | [optional] 
+**fully_qualified_schema_name** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**schema_name** | **String** |  | [optional] 
+**type** | [**KnowledgeBaseObjectTypes**](KnowledgeBaseObjectTypes.md) |  | [optional] 
+**version** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::IReadOnlyKnowledgeBaseObjectDefinition.new(id: null,
+                                 _alias: null,
+                                 all_field_definition_set: null,
+                                 deleted_field_definition_set: null,
+                                 features: null,
+                                 field_definition_set: null,
+                                 fully_qualified_schema_name: null,
+                                 name: null,
+                                 schema_name: null,
+                                 type: null,
+                                 version: null)
+```
+
+