cmv4-openapi-client 1.0.3

data/docs/RelationshipStakeholdersApi.md

@@ -0,0 +1,458 @@
+# CMV4APIClient::RelationshipStakeholdersApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stakeholders_create2**](RelationshipStakeholdersApi.md#stakeholders_create2) | **POST** /relationships/CorrespondenceToStakeholder | Create a new CorrespondenceToStakeholder relationship
+[**stakeholders_delete2**](RelationshipStakeholdersApi.md#stakeholders_delete2) | **DELETE** /relationships/CorrespondenceToStakeholder/{id} | Delete a CorrespondenceToStakeholder
+[**stakeholders_delete_using_post2**](RelationshipStakeholdersApi.md#stakeholders_delete_using_post2) | **POST** /relationships/CorrespondenceToStakeholder/{id}/delete | Delete a CorrespondenceToStakeholder
+[**stakeholders_get_all2**](RelationshipStakeholdersApi.md#stakeholders_get_all2) | **GET** /relationships/CorrespondenceToStakeholder?{page}&{pageSize} | Gets All Stakeholders Data
+[**stakeholders_get_by_id2**](RelationshipStakeholdersApi.md#stakeholders_get_by_id2) | **GET** /relationships/CorrespondenceToStakeholder/{id} | Get CorrespondenceToStakeholder By Id
+[**stakeholders_get_count2**](RelationshipStakeholdersApi.md#stakeholders_get_count2) | **GET** /relationships/CorrespondenceToStakeholder/count | Get Stakeholders Count
+[**stakeholders_modify2**](RelationshipStakeholdersApi.md#stakeholders_modify2) | **PATCH** /relationships/CorrespondenceToStakeholder/{id} | Modify a CorrespondenceToStakeholder
+[**stakeholders_restore2**](RelationshipStakeholdersApi.md#stakeholders_restore2) | **POST** /relationships/CorrespondenceToStakeholder/{id}/restore | Restore a CorrespondenceToStakeholder
+
+
+
+## stakeholders_create2
+
+> Stakeholders stakeholders_create2(ensure_relationship_instance_command_data)
+
+Create a new CorrespondenceToStakeholder relationship
+
+Creates a new CorrespondenceToStakeholder 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::RelationshipStakeholdersApi.new
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"deliveryStatus":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"LeftHandId":0,"deliveryDetails":"","RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Create a new CorrespondenceToStakeholder relationship
+  result = api_instance.stakeholders_create2(ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_create2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Stakeholders**](Stakeholders.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
+
+
+## stakeholders_delete2
+
+> Object stakeholders_delete2(id)
+
+Delete a CorrespondenceToStakeholder
+
+Deletes an existing CorrespondenceToStakeholder.
+
+### 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::RelationshipStakeholdersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a CorrespondenceToStakeholder
+  result = api_instance.stakeholders_delete2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_delete2: #{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
+
+
+## stakeholders_delete_using_post2
+
+> Object stakeholders_delete_using_post2(id)
+
+Delete a CorrespondenceToStakeholder
+
+Deletes an existing CorrespondenceToStakeholder.
+
+### 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::RelationshipStakeholdersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a CorrespondenceToStakeholder
+  result = api_instance.stakeholders_delete_using_post2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_delete_using_post2: #{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
+
+
+## stakeholders_get_all2
+
+> Stakeholders stakeholders_get_all2(opts)
+
+Gets All Stakeholders Data
+
+Gets all the data for the stakeholders 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::RelationshipStakeholdersApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Gets All Stakeholders Data
+  result = api_instance.stakeholders_get_all2(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_get_all2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Stakeholders**](Stakeholders.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
+
+
+## stakeholders_get_by_id2
+
+> Stakeholders stakeholders_get_by_id2(id)
+
+Get CorrespondenceToStakeholder By Id
+
+Gets a single CorrespondenceToStakeholder 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::RelationshipStakeholdersApi.new
+id = 56 # Integer |
+
+begin
+  #Get CorrespondenceToStakeholder By Id
+  result = api_instance.stakeholders_get_by_id2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_get_by_id2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Stakeholders**](Stakeholders.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
+
+
+## stakeholders_get_count2
+
+> Integer stakeholders_get_count2
+
+Get Stakeholders Count
+
+Gets the count of all Stakeholders
+
+### 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::RelationshipStakeholdersApi.new
+
+begin
+  #Get Stakeholders Count
+  result = api_instance.stakeholders_get_count2
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_get_count2: #{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
+
+
+## stakeholders_modify2
+
+> Stakeholders stakeholders_modify2(id, ensure_relationship_instance_command_data)
+
+Modify a CorrespondenceToStakeholder
+
+Modify an existing CorrespondenceToStakeholder.
+
+### 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::RelationshipStakeholdersApi.new
+id = 56 # Integer |
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"deliveryStatus":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"LeftHandId":0,"deliveryDetails":"","RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Modify a CorrespondenceToStakeholder
+  result = api_instance.stakeholders_modify2(id, ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_modify2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Stakeholders**](Stakeholders.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
+
+
+## stakeholders_restore2
+
+> Object stakeholders_restore2(id)
+
+Restore a CorrespondenceToStakeholder
+
+Restores a CorrespondenceToStakeholder.
+
+### 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::RelationshipStakeholdersApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a CorrespondenceToStakeholder
+  result = api_instance.stakeholders_restore2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholdersApi->stakeholders_restore2: #{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
+