cmv4-openapi-client 1.0.3

data/docs/EntityEventsApi.md

@@ -0,0 +1,572 @@
+# CMV4APIClient::EntityEventsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**events_clone**](EntityEventsApi.md#events_clone) | **POST** /entities/event/{id}/clone | Clone an existing event
+[**events_create**](EntityEventsApi.md#events_create) | **POST** /entities/event | Create a new event
+[**events_delete**](EntityEventsApi.md#events_delete) | **DELETE** /entities/event/{id} | Delete a event
+[**events_delete_using_post**](EntityEventsApi.md#events_delete_using_post) | **POST** /entities/event/{id}/delete | Delete a event
+[**events_get_all**](EntityEventsApi.md#events_get_all) | **GET** /entities/event?{page}&{pageSize} | Get All Events
+[**events_get_by_id**](EntityEventsApi.md#events_get_by_id) | **GET** /entities/event/{id} | Get Event By Id
+[**events_get_count**](EntityEventsApi.md#events_get_count) | **GET** /entities/event/count | Get Events Count
+[**events_merge**](EntityEventsApi.md#events_merge) | **POST** /entities/event/{id}/merge | Merge Events
+[**events_modify**](EntityEventsApi.md#events_modify) | **PATCH** /entities/event/{id} | Modify a event
+[**events_restore**](EntityEventsApi.md#events_restore) | **POST** /entities/event/{id}/restore | Restore a event
+
+
+
+## events_clone
+
+> Event events_clone(id)
+
+Clone an existing event
+
+Clones an existing event.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+
+begin
+  #Clone an existing event
+  result = api_instance.events_clone(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_clone: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_create
+
+> Event events_create(ensure_entity_instance_command_data)
+
+Create a new event
+
+Creates a new event.
+
+### 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::EntityEventsApi.new
+ensure_entity_instance_command_data = {"DataVersion":0,"ProjectOperations":{"Relate":[0],"Unrelate":[0]},"Values":{"eventType":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"address.location":"","address.state":"","sentimentevents":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"startDate":"2020-03-25T08:41:19","address.suburb":"","location":"","relatedProperty":[null],"relatedProjects":[null],"relatedStakeholder":[null],"summary":"","relatedUser":[null],"address.country":"","teamResponse":"","address":{"Address":null,"PostCode":null,"Suburb":null,"State":null,"Country":null,"Location":null,"DateGeocoded":null},"issues":null,"comments":"","address.postCode":"","address.address":"","endDate":"2020-03-25T08:41:19"}} # EnsureEntityInstanceCommandData |
+
+begin
+  #Create a new event
+  result = api_instance.events_create(ensure_entity_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_entity_instance_command_data** | [**EnsureEntityInstanceCommandData**](EnsureEntityInstanceCommandData.md)|  |
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_delete
+
+> Object events_delete(id)
+
+Delete a event
+
+Deletes an existing event.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a event
+  result = api_instance.events_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_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
+
+
+## events_delete_using_post
+
+> Object events_delete_using_post(id)
+
+Delete a event
+
+Deletes an existing event.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a event
+  result = api_instance.events_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_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
+
+
+## events_get_all
+
+> Event events_get_all(opts)
+
+Get All Events
+
+Gets all events 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::EntityEventsApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Get All Events
+  result = api_instance.events_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_get_by_id
+
+> Event events_get_by_id(id)
+
+Get Event By Id
+
+Gets a single event 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::EntityEventsApi.new
+id = 56 # Integer |
+
+begin
+  #Get Event By Id
+  result = api_instance.events_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_get_count
+
+> Integer events_get_count
+
+Get Events Count
+
+Gets the count of all events
+
+### 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::EntityEventsApi.new
+
+begin
+  #Get Events Count
+  result = api_instance.events_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_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
+
+
+## events_merge
+
+> Event events_merge(id, merge_entity_instances_command_data)
+
+Merge Events
+
+Merge existing events.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+merge_entity_instances_command_data = CMV4APIClient::MergeEntityInstancesCommandData.new # MergeEntityInstancesCommandData |
+
+begin
+  #Merge Events
+  result = api_instance.events_merge(id, merge_entity_instances_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_merge: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **merge_entity_instances_command_data** | [**MergeEntityInstancesCommandData**](MergeEntityInstancesCommandData.md)|  |
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_modify
+
+> Event events_modify(id, ensure_entity_instance_command_data)
+
+Modify a event
+
+Modify an existing event.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+ensure_entity_instance_command_data = {"DataVersion":0,"ProjectOperations":{"Relate":[0],"Unrelate":[0]},"Values":{"eventType":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"address.location":"","address.state":"","sentimentevents":{"Id":0,"Deleted":false,"Name":null,"Hierarchy":null,"Visibility":0},"startDate":"2020-03-25T08:41:19","address.suburb":"","location":"","relatedProperty":[null],"relatedProjects":[null],"relatedStakeholder":[null],"summary":"","relatedUser":[null],"address.country":"","teamResponse":"","address":{"Address":null,"PostCode":null,"Suburb":null,"State":null,"Country":null,"Location":null,"DateGeocoded":null},"issues":null,"comments":"","address.postCode":"","address.address":"","endDate":"2020-03-25T08:41:19"}} # EnsureEntityInstanceCommandData |
+
+begin
+  #Modify a event
+  result = api_instance.events_modify(id, ensure_entity_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_entity_instance_command_data** | [**EnsureEntityInstanceCommandData**](EnsureEntityInstanceCommandData.md)|  |
+
+### Return type
+
+[**Event**](Event.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
+
+
+## events_restore
+
+> Object events_restore(id)
+
+Restore a event
+
+Restores a event.
+
+### 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::EntityEventsApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a event
+  result = api_instance.events_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityEventsApi->events_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
+