cmv4-openapi-client 1.0.3

data/docs/EntityUsersApi.md

@@ -0,0 +1,572 @@
+# CMV4APIClient::EntityUsersApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**users_clone**](EntityUsersApi.md#users_clone) | **POST** /entities/user/{id}/clone | Clone an existing user
+[**users_create**](EntityUsersApi.md#users_create) | **POST** /entities/user | Create User
+[**users_delete**](EntityUsersApi.md#users_delete) | **DELETE** /entities/user/{id} | Delete a user
+[**users_delete_using_post**](EntityUsersApi.md#users_delete_using_post) | **POST** /entities/user/{id}/delete | Delete a user
+[**users_get_all**](EntityUsersApi.md#users_get_all) | **GET** /entities/user?{page}&{pageSize} | Get All Users
+[**users_get_by_id**](EntityUsersApi.md#users_get_by_id) | **GET** /entities/user/{id} | Get User By Id
+[**users_get_count**](EntityUsersApi.md#users_get_count) | **GET** /entities/user/count | Get Users Count
+[**users_merge**](EntityUsersApi.md#users_merge) | **POST** /entities/user/{id}/merge | Merge Users
+[**users_modify**](EntityUsersApi.md#users_modify) | **PATCH** /entities/user/{id} | Modify a user
+[**users_restore**](EntityUsersApi.md#users_restore) | **POST** /entities/user/{id}/restore | Restore a user
+
+
+
+## users_clone
+
+> User users_clone(id)
+
+Clone an existing user
+
+Clones an existing user.
+
+### 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::EntityUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Clone an existing user
+  result = api_instance.users_clone(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_clone: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**User**](User.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_create
+
+> User users_create(ensure_user_command_data)
+
+Create User
+
+Creates a new user.
+
+### 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::EntityUsersApi.new
+ensure_user_command_data = {"StereotypeOperations":{"Relate":{},"Unrelate":{}},"SendOnboardingEmail":false,"DataVersion":0,"Values":{"useLegacyLogin":false,"phone":"","firstName":"","organisation":"","login":"","notes":"","fax":"","department":"","position":"","mobile":"","email":"","lastName":""}} # EnsureUserCommandData |
+
+begin
+  #Create User
+  result = api_instance.users_create(ensure_user_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_user_command_data** | [**EnsureUserCommandData**](EnsureUserCommandData.md)|  |
+
+### Return type
+
+[**User**](User.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_delete
+
+> Object users_delete(id)
+
+Delete a user
+
+Deletes an existing user.
+
+### 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::EntityUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a user
+  result = api_instance.users_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_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
+
+
+## users_delete_using_post
+
+> Object users_delete_using_post(id)
+
+Delete a user
+
+Deletes an existing user.
+
+### 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::EntityUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a user
+  result = api_instance.users_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_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
+
+
+## users_get_all
+
+> User users_get_all(opts)
+
+Get All Users
+
+Gets all users and allows for the results to be paged.
+
+### 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::EntityUsersApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Get All Users
+  result = api_instance.users_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**User**](User.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_id
+
+> User users_get_by_id(id)
+
+Get User By Id
+
+Gets a single user 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::EntityUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Get User By Id
+  result = api_instance.users_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**User**](User.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_count
+
+> Integer users_get_count
+
+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::EntityUsersApi.new
+
+begin
+  #Get Users Count
+  result = api_instance.users_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_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
+
+
+## users_merge
+
+> User users_merge(id, merge_entity_instances_command_data)
+
+Merge Users
+
+Merge existing 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::EntityUsersApi.new
+id = 56 # Integer |
+merge_entity_instances_command_data = CMV4APIClient::MergeEntityInstancesCommandData.new # MergeEntityInstancesCommandData |
+
+begin
+  #Merge Users
+  result = api_instance.users_merge(id, merge_entity_instances_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_merge: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **merge_entity_instances_command_data** | [**MergeEntityInstancesCommandData**](MergeEntityInstancesCommandData.md)|  |
+
+### Return type
+
+[**User**](User.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_modify
+
+> User users_modify(id, ensure_entity_instance_command_data)
+
+Modify a user
+
+Modify an existing user.
+
+### 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::EntityUsersApi.new
+id = 56 # Integer |
+ensure_entity_instance_command_data = {"DataVersion":0,"ProjectOperations":{"Relate":[0],"Unrelate":[0]},"Values":{"useLegacyLogin":false,"phone":"","firstName":"","organisation":"","login":"","notes":"","fax":"","department":"","position":"","mobile":"","email":"","lastName":""}} # EnsureEntityInstanceCommandData |
+
+begin
+  #Modify a user
+  result = api_instance.users_modify(id, ensure_entity_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_entity_instance_command_data** | [**EnsureEntityInstanceCommandData**](EnsureEntityInstanceCommandData.md)|  |
+
+### Return type
+
+[**User**](User.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_restore
+
+> Object users_restore(id)
+
+Restore a user
+
+Restores a user.
+
+### 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::EntityUsersApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a user
+  result = api_instance.users_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityUsersApi->users_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/Event.md

@@ -0,0 +1,75 @@
+# CMV4APIClient::Event
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional]
+**address** | [**AddressModel**](AddressModel.md) |  | [optional]
+**address_address** | **String** |  | [optional]
+**address_country** | **String** |  | [optional]
+**address_location** | **String** |  | [optional]
+**address_post_code** | **String** |  | [optional]
+**address_state** | **String** |  | [optional]
+**address_suburb** | **String** |  | [optional]
+**comments** | **String** |  | [optional]
+**created** | **DateTime** |  | [optional]
+**created_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**database_id** | **String** |  | [optional]
+**deleted** | **Boolean** |  | [optional]
+**descriptor** | **String** |  | [optional]
+**end_date** | **DateTime** |  | [optional]
+**event_type** | [**ClassificationModel**](ClassificationModel.md) |  | [optional]
+**issues** | [**ClassificationSetModel**](ClassificationSetModel.md) |  | [optional]
+**location** | **String** |  | [optional]
+**modified** | **DateTime** |  | [optional]
+**modified_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**modified_end_time** | **DateTime** |  | [optional]
+**related_projects** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**related_property** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**related_stakeholder** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**related_user** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**sentimentevents** | [**ClassificationModel**](ClassificationModel.md) |  | [optional]
+**start_date** | **DateTime** |  | [optional]
+**summary** | **String** |  | [optional]
+**team_response** | **String** |  | [optional]
+**visibility** | **Integer** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::Event.new(id: null,
+                                 address: null,
+                                 address_address: null,
+                                 address_country: null,
+                                 address_location: null,
+                                 address_post_code: null,
+                                 address_state: null,
+                                 address_suburb: null,
+                                 comments: null,
+                                 created: null,
+                                 created_by: null,
+                                 database_id: null,
+                                 deleted: null,
+                                 descriptor: null,
+                                 end_date: null,
+                                 event_type: null,
+                                 issues: null,
+                                 location: null,
+                                 modified: null,
+                                 modified_by: null,
+                                 modified_end_time: null,
+                                 related_projects: null,
+                                 related_property: null,
+                                 related_stakeholder: null,
+                                 related_user: null,
+                                 sentimentevents: null,
+                                 start_date: null,
+                                 summary: null,
+                                 team_response: null,
+                                 visibility: null)
+```
+
+

data/docs/EventActionRelationship.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::EventActionRelationship
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional]
+**created** | **DateTime** |  | [optional]
+**created_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**database_id** | **String** |  | [optional]
+**deleted** | **Boolean** |  | [optional]
+**left_hand_id** | **Integer** |  | [optional]
+**modified** | **DateTime** |  | [optional]
+**modified_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**modified_end_time** | **DateTime** |  | [optional]
+**right_hand_id** | **Integer** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::EventActionRelationship.new(id: null,
+                                 created: null,
+                                 created_by: null,
+                                 database_id: null,
+                                 deleted: null,
+                                 left_hand_id: null,
+                                 modified: null,
+                                 modified_by: null,
+                                 modified_end_time: null,
+                                 right_hand_id: null)
+```
+
+

data/docs/EventDocumentRelationship.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::EventDocumentRelationship
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional]
+**created** | **DateTime** |  | [optional]
+**created_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**database_id** | **String** |  | [optional]
+**deleted** | **Boolean** |  | [optional]
+**left_hand_id** | **Integer** |  | [optional]
+**modified** | **DateTime** |  | [optional]
+**modified_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**modified_end_time** | **DateTime** |  | [optional]
+**right_hand_id** | **Integer** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::EventDocumentRelationship.new(id: null,
+                                 created: null,
+                                 created_by: null,
+                                 database_id: null,
+                                 deleted: null,
+                                 left_hand_id: null,
+                                 modified: null,
+                                 modified_by: null,
+                                 modified_end_time: null,
+                                 right_hand_id: null)
+```
+
+