cmv4-openapi-client 1.0.3

data/docs/RelationshipStakeholderPropertiesApi.md

@@ -0,0 +1,458 @@
+# CMV4APIClient::RelationshipStakeholderPropertiesApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stakeholder_properties_create**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_create) | **POST** /relationships/spr | Create a new spr relationship
+[**stakeholder_properties_delete**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_delete) | **DELETE** /relationships/spr/{id} | Delete a spr
+[**stakeholder_properties_delete_using_post**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_delete_using_post) | **POST** /relationships/spr/{id}/delete | Delete a spr
+[**stakeholder_properties_get_all**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_get_all) | **GET** /relationships/spr?{page}&{pageSize} | Gets All Stakeholder Properties Data
+[**stakeholder_properties_get_by_id**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_get_by_id) | **GET** /relationships/spr/{id} | Get spr By Id
+[**stakeholder_properties_get_count**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_get_count) | **GET** /relationships/spr/count | Get Stakeholder Properties Count
+[**stakeholder_properties_modify**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_modify) | **PATCH** /relationships/spr/{id} | Modify a spr
+[**stakeholder_properties_restore**](RelationshipStakeholderPropertiesApi.md#stakeholder_properties_restore) | **POST** /relationships/spr/{id}/restore | Restore a spr
+
+
+
+## stakeholder_properties_create
+
+> StakeholderProperty stakeholder_properties_create(ensure_relationship_instance_command_data)
+
+Create a new spr relationship
+
+Creates a new spr 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::RelationshipStakeholderPropertiesApi.new
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"ownership":"","LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Create a new spr relationship
+  result = api_instance.stakeholder_properties_create(ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**StakeholderProperty**](StakeholderProperty.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
+
+
+## stakeholder_properties_delete
+
+> Object stakeholder_properties_delete(id)
+
+Delete a spr
+
+Deletes an existing spr.
+
+### 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::RelationshipStakeholderPropertiesApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a spr
+  result = api_instance.stakeholder_properties_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_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
+
+
+## stakeholder_properties_delete_using_post
+
+> Object stakeholder_properties_delete_using_post(id)
+
+Delete a spr
+
+Deletes an existing spr.
+
+### 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::RelationshipStakeholderPropertiesApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a spr
+  result = api_instance.stakeholder_properties_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_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
+
+
+## stakeholder_properties_get_all
+
+> StakeholderProperty stakeholder_properties_get_all(opts)
+
+Gets All Stakeholder Properties Data
+
+Gets all the data for the stakeholder properties 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::RelationshipStakeholderPropertiesApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Gets All Stakeholder Properties Data
+  result = api_instance.stakeholder_properties_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**StakeholderProperty**](StakeholderProperty.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
+
+
+## stakeholder_properties_get_by_id
+
+> StakeholderProperty stakeholder_properties_get_by_id(id)
+
+Get spr By Id
+
+Gets a single spr 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::RelationshipStakeholderPropertiesApi.new
+id = 56 # Integer |
+
+begin
+  #Get spr By Id
+  result = api_instance.stakeholder_properties_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**StakeholderProperty**](StakeholderProperty.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
+
+
+## stakeholder_properties_get_count
+
+> Integer stakeholder_properties_get_count
+
+Get Stakeholder Properties Count
+
+Gets the count of all Stakeholder Properties
+
+### 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::RelationshipStakeholderPropertiesApi.new
+
+begin
+  #Get Stakeholder Properties Count
+  result = api_instance.stakeholder_properties_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_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
+
+
+## stakeholder_properties_modify
+
+> StakeholderProperty stakeholder_properties_modify(id, ensure_relationship_instance_command_data)
+
+Modify a spr
+
+Modify an existing spr.
+
+### 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::RelationshipStakeholderPropertiesApi.new
+id = 56 # Integer |
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"ownership":"","LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Modify a spr
+  result = api_instance.stakeholder_properties_modify(id, ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**StakeholderProperty**](StakeholderProperty.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
+
+
+## stakeholder_properties_restore
+
+> Object stakeholder_properties_restore(id)
+
+Restore a spr
+
+Restores a spr.
+
+### 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::RelationshipStakeholderPropertiesApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a spr
+  result = api_instance.stakeholder_properties_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipStakeholderPropertiesApi->stakeholder_properties_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
+