cmv4-openapi-client 1.0.3

data/docs/RelationshipCorrespondenceProjectRelationshipsApi.md

@@ -0,0 +1,458 @@
+# CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**correspondence_project_relationships_create**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_create) | **POST** /relationships/correspondenceProjectRelationship | Create a new correspondenceProjectRelationship relationship
+[**correspondence_project_relationships_delete**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_delete) | **DELETE** /relationships/correspondenceProjectRelationship/{id} | Delete a correspondenceProjectRelationship
+[**correspondence_project_relationships_delete_using_post**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_delete_using_post) | **POST** /relationships/correspondenceProjectRelationship/{id}/delete | Delete a correspondenceProjectRelationship
+[**correspondence_project_relationships_get_all**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_get_all) | **GET** /relationships/correspondenceProjectRelationship?{page}&{pageSize} | Gets All CorrespondenceProjectRelationships Data
+[**correspondence_project_relationships_get_by_id**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_get_by_id) | **GET** /relationships/correspondenceProjectRelationship/{id} | Get correspondenceProjectRelationship By Id
+[**correspondence_project_relationships_get_count**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_get_count) | **GET** /relationships/correspondenceProjectRelationship/count | Get CorrespondenceProjectRelationships Count
+[**correspondence_project_relationships_modify**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_modify) | **PATCH** /relationships/correspondenceProjectRelationship/{id} | Modify a correspondenceProjectRelationship
+[**correspondence_project_relationships_restore**](RelationshipCorrespondenceProjectRelationshipsApi.md#correspondence_project_relationships_restore) | **POST** /relationships/correspondenceProjectRelationship/{id}/restore | Restore a correspondenceProjectRelationship
+
+
+
+## correspondence_project_relationships_create
+
+> Correspondence correspondence_project_relationships_create(ensure_relationship_instance_command_data)
+
+Create a new correspondenceProjectRelationship relationship
+
+Creates a new correspondenceProjectRelationship relationship
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Create a new correspondenceProjectRelationship relationship
+  result = api_instance.correspondence_project_relationships_create(ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Correspondence**](Correspondence.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_delete
+
+> Object correspondence_project_relationships_delete(id)
+
+Delete a correspondenceProjectRelationship
+
+Deletes an existing correspondenceProjectRelationship.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a correspondenceProjectRelationship
+  result = api_instance.correspondence_project_relationships_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_delete_using_post
+
+> Object correspondence_project_relationships_delete_using_post(id)
+
+Delete a correspondenceProjectRelationship
+
+Deletes an existing correspondenceProjectRelationship.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a correspondenceProjectRelationship
+  result = api_instance.correspondence_project_relationships_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_delete_using_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_get_all
+
+> Correspondence correspondence_project_relationships_get_all(opts)
+
+Gets All CorrespondenceProjectRelationships Data
+
+Gets all the data for the correspondenceprojectrelationships relationship
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Gets All CorrespondenceProjectRelationships Data
+  result = api_instance.correspondence_project_relationships_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Correspondence**](Correspondence.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_get_by_id
+
+> Correspondence correspondence_project_relationships_get_by_id(id)
+
+Get correspondenceProjectRelationship By Id
+
+Gets a single correspondenceProjectRelationship by its Id
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+id = 56 # Integer |
+
+begin
+  #Get correspondenceProjectRelationship By Id
+  result = api_instance.correspondence_project_relationships_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Correspondence**](Correspondence.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_get_count
+
+> Integer correspondence_project_relationships_get_count
+
+Get CorrespondenceProjectRelationships Count
+
+Gets the count of all CorrespondenceProjectRelationships
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+
+begin
+  #Get CorrespondenceProjectRelationships Count
+  result = api_instance.correspondence_project_relationships_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_get_count: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_modify
+
+> Correspondence correspondence_project_relationships_modify(id, ensure_relationship_instance_command_data)
+
+Modify a correspondenceProjectRelationship
+
+Modify an existing correspondenceProjectRelationship.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+id = 56 # Integer |
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Modify a correspondenceProjectRelationship
+  result = api_instance.correspondence_project_relationships_modify(id, ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Correspondence**](Correspondence.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## correspondence_project_relationships_restore
+
+> Object correspondence_project_relationships_restore(id)
+
+Restore a correspondenceProjectRelationship
+
+Restores a correspondenceProjectRelationship.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipCorrespondenceProjectRelationshipsApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a correspondenceProjectRelationship
+  result = api_instance.correspondence_project_relationships_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipCorrespondenceProjectRelationshipsApi->correspondence_project_relationships_restore: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RelationshipDefinition.md

@@ -0,0 +1,43 @@
+# CMV4APIClient::RelationshipDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**_alias** | **String** |  | [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] 
+**name** | **String** |  | [optional] 
+**plural_name** | **String** |  | [optional] 
+**schema_name** | **String** |  | [optional] 
+**version** | **Integer** |  | [optional] 
+**nature** | [**DomainObjectNature**](DomainObjectNature.md) |  | [optional] 
+**format** | [**RelationshipFormat**](RelationshipFormat.md) |  | [optional] 
+**left_hand_entity** | **String** |  | [optional] 
+**relationship_description** | **String** |  | [optional] 
+**right_hand_entity** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::RelationshipDefinition.new(id: null,
+                                 _alias: null,
+                                 deleted_field_definition_set: null,
+                                 features: null,
+                                 field_definition_set: null,
+                                 name: null,
+                                 plural_name: null,
+                                 schema_name: null,
+                                 version: null,
+                                 nature: null,
+                                 format: null,
+                                 left_hand_entity: null,
+                                 relationship_description: null,
+                                 right_hand_entity: null)
+```
+
+

data/docs/RelationshipDefinitionAllOf.md

@@ -0,0 +1,25 @@
+# CMV4APIClient::RelationshipDefinitionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**format** | [**RelationshipFormat**](RelationshipFormat.md) |  | [optional] 
+**left_hand_entity** | **String** |  | [optional] 
+**nature** | [**DomainObjectNature**](DomainObjectNature.md) |  | [optional] 
+**relationship_description** | **String** |  | [optional] 
+**right_hand_entity** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::RelationshipDefinitionAllOf.new(format: null,
+                                 left_hand_entity: null,
+                                 nature: null,
+                                 relationship_description: null,
+                                 right_hand_entity: null)
+```
+
+