cmv4-openapi-client 1.0.3

data/docs/RelationshipUsersApi.md

@@ -0,0 +1,458 @@
+# CMV4APIClient::RelationshipUsersApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**users_create2**](RelationshipUsersApi.md#users_create2) | **POST** /relationships/CorrespondenceToUser | Create a new CorrespondenceToUser relationship
+[**users_delete2**](RelationshipUsersApi.md#users_delete2) | **DELETE** /relationships/CorrespondenceToUser/{id} | Delete a CorrespondenceToUser
+[**users_delete_using_post2**](RelationshipUsersApi.md#users_delete_using_post2) | **POST** /relationships/CorrespondenceToUser/{id}/delete | Delete a CorrespondenceToUser
+[**users_get_all2**](RelationshipUsersApi.md#users_get_all2) | **GET** /relationships/CorrespondenceToUser?{page}&{pageSize} | Gets All Users Data
+[**users_get_by_id2**](RelationshipUsersApi.md#users_get_by_id2) | **GET** /relationships/CorrespondenceToUser/{id} | Get CorrespondenceToUser By Id
+[**users_get_count2**](RelationshipUsersApi.md#users_get_count2) | **GET** /relationships/CorrespondenceToUser/count | Get Users Count
+[**users_modify2**](RelationshipUsersApi.md#users_modify2) | **PATCH** /relationships/CorrespondenceToUser/{id} | Modify a CorrespondenceToUser
+[**users_restore2**](RelationshipUsersApi.md#users_restore2) | **POST** /relationships/CorrespondenceToUser/{id}/restore | Restore a CorrespondenceToUser
+
+
+
+## users_create2
+
+> Users users_create2(ensure_relationship_instance_command_data)
+
+Create a new CorrespondenceToUser relationship
+
+Creates a new CorrespondenceToUser 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::RelationshipUsersApi.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 CorrespondenceToUser relationship
+  result = api_instance.users_create2(ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_create2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Users**](Users.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
+
+
+## users_delete2
+
+> Object users_delete2(id)
+
+Delete a CorrespondenceToUser
+
+Deletes an existing CorrespondenceToUser.
+
+### 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::RelationshipUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a CorrespondenceToUser
+  result = api_instance.users_delete2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_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
+
+
+## users_delete_using_post2
+
+> Object users_delete_using_post2(id)
+
+Delete a CorrespondenceToUser
+
+Deletes an existing CorrespondenceToUser.
+
+### 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::RelationshipUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a CorrespondenceToUser
+  result = api_instance.users_delete_using_post2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_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
+
+
+## users_get_all2
+
+> Users users_get_all2(opts)
+
+Gets All Users Data
+
+Gets all the data for the users 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::RelationshipUsersApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Gets All Users Data
+  result = api_instance.users_get_all2(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_get_all2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Users**](Users.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
+
+
+## users_get_by_id2
+
+> Users users_get_by_id2(id)
+
+Get CorrespondenceToUser By Id
+
+Gets a single CorrespondenceToUser 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::RelationshipUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Get CorrespondenceToUser By Id
+  result = api_instance.users_get_by_id2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_get_by_id2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Users**](Users.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
+
+
+## users_get_count2
+
+> Integer users_get_count2
+
+Get Users Count
+
+Gets the count of all Users
+
+### 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::RelationshipUsersApi.new
+
+begin
+  #Get Users Count
+  result = api_instance.users_get_count2
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_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
+
+
+## users_modify2
+
+> Users users_modify2(id, ensure_relationship_instance_command_data)
+
+Modify a CorrespondenceToUser
+
+Modify an existing CorrespondenceToUser.
+
+### 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::RelationshipUsersApi.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 CorrespondenceToUser
+  result = api_instance.users_modify2(id, ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_modify2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Users**](Users.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
+
+
+## users_restore2
+
+> Object users_restore2(id)
+
+Restore a CorrespondenceToUser
+
+Restores a CorrespondenceToUser.
+
+### 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::RelationshipUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a CorrespondenceToUser
+  result = api_instance.users_restore2(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipUsersApi->users_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
+

data/docs/ResetPasswordData.md

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

data/docs/ResourceModel.md

@@ -0,0 +1,27 @@
+# CMV4APIClient::ResourceModel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_type** | **String** |  | [optional] 
+**deleted** | **Boolean** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**storage_uri** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ResourceModel.new(content_type: null,
+                                 deleted: null,
+                                 identifier: null,
+                                 name: null,
+                                 size: null,
+                                 storage_uri: null)
+```
+
+

data/docs/SearchRequest.md

@@ -0,0 +1,37 @@
+# CMV4APIClient::SearchRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ambient_projects** | **Array<Integer>** |  | [optional]
+**dsl** | **String** |  | [optional]
+**fields** | **Array<String>** |  | [optional]
+**include_globals** | **Boolean** |  | [optional]
+**measure** | [**Measures**](Measures.md) |  | [optional]
+**modifiers** | [**Array<IModifier>**](IModifier.md) |  | [optional]
+**order_by** | **Array<String>** |  | [optional]
+**page** | **Integer** |  | [optional]
+**page_size** | **Integer** |  | [optional]
+**permissions** | **Array<String>** |  | [optional]
+**results_format** | [**SearchResultsFormat**](SearchResultsFormat.md) |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::SearchRequest.new(ambient_projects: null,
+                                 dsl: null,
+                                 fields: null,
+                                 include_globals: null,
+                                 measure: null,
+                                 modifiers: null,
+                                 order_by: null,
+                                 page: null,
+                                 page_size: null,
+                                 permissions: null,
+                                 results_format: null)
+```
+
+

data/docs/SearchResultsFormat.md

@@ -0,0 +1,16 @@
+# CMV4APIClient::SearchResultsFormat
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::SearchResultsFormat.new()
+```
+
+

data/docs/SecurityControllerReadApi.md

@@ -0,0 +1,55 @@
+# CMV4APIClient::SecurityControllerReadApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**security_controller_read_get_security_for_entity_all**](SecurityControllerReadApi.md#security_controller_read_get_security_for_entity_all) | **POST** /security/entity/{alias} | 
+
+
+
+## security_controller_read_get_security_for_entity_all
+
+> Array<DomainObjectPermissions> security_controller_read_get_security_for_entity_all(_alias, request_body)
+
+
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::SecurityControllerReadApi.new
+_alias = '_alias_example' # String | 
+request_body = [56] # Array<Integer> | 
+
+begin
+  result = api_instance.security_controller_read_get_security_for_entity_all(_alias, request_body)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling SecurityControllerReadApi->security_controller_read_get_security_for_entity_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_alias** | **String**|  | 
+ **request_body** | [**Array&lt;Integer&gt;**](Integer.md)|  | 
+
+### Return type
+
+[**Array&lt;DomainObjectPermissions&gt;**](DomainObjectPermissions.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+