cmv4-openapi-client 1.0.3

data/docs/EntityProjectsApi.md

@@ -0,0 +1,572 @@
+# CMV4APIClient::EntityProjectsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**projects_clone**](EntityProjectsApi.md#projects_clone) | **POST** /entities/project/{id}/clone | Clone an existing project
+[**projects_create**](EntityProjectsApi.md#projects_create) | **POST** /entities/project | Create Project
+[**projects_delete**](EntityProjectsApi.md#projects_delete) | **DELETE** /entities/project/{id} | Delete a project
+[**projects_delete_using_post**](EntityProjectsApi.md#projects_delete_using_post) | **POST** /entities/project/{id}/delete | Delete a project
+[**projects_get_all**](EntityProjectsApi.md#projects_get_all) | **GET** /entities/project?{page}&{pageSize} | Get All Projects
+[**projects_get_by_id**](EntityProjectsApi.md#projects_get_by_id) | **GET** /entities/project/{id} | Get Project By Id
+[**projects_get_count**](EntityProjectsApi.md#projects_get_count) | **GET** /entities/project/count | Get Projects Count
+[**projects_merge**](EntityProjectsApi.md#projects_merge) | **POST** /entities/project/{id}/merge | Merge Projects
+[**projects_modify**](EntityProjectsApi.md#projects_modify) | **PATCH** /entities/project/{id} | Modify a project
+[**projects_restore**](EntityProjectsApi.md#projects_restore) | **POST** /entities/project/{id}/restore | Restore a project
+
+
+
+## projects_clone
+
+> Project2 projects_clone(id)
+
+Clone an existing project
+
+Clones an existing project.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+
+begin
+  #Clone an existing project
+  result = api_instance.projects_clone(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_clone: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_create
+
+> Project2 projects_create(ensure_project_command_data)
+
+Create Project
+
+Creates a new project.
+
+### 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::EntityProjectsApi.new
+ensure_project_command_data = {"DataVersion":0,"Values":{"timeZone":"","currentcapacityml":0,"percentagefull":0,"fullsupplycapacityml":0,"notes":"","dateEnd":"2020-03-25T08:41:19","projectGroup":null,"name":"","dateStart":"2020-03-25T08:41:19"}} # EnsureProjectCommandData |
+
+begin
+  #Create Project
+  result = api_instance.projects_create(ensure_project_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_project_command_data** | [**EnsureProjectCommandData**](EnsureProjectCommandData.md)|  |
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_delete
+
+> Object projects_delete(id)
+
+Delete a project
+
+Deletes an existing project.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a project
+  result = api_instance.projects_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_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
+
+
+## projects_delete_using_post
+
+> Object projects_delete_using_post(id)
+
+Delete a project
+
+Deletes an existing project.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a project
+  result = api_instance.projects_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_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
+
+
+## projects_get_all
+
+> Project2 projects_get_all(opts)
+
+Get All Projects
+
+Gets all projects 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::EntityProjectsApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Get All Projects
+  result = api_instance.projects_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_get_by_id
+
+> Project2 projects_get_by_id(id)
+
+Get Project By Id
+
+Gets a single project 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::EntityProjectsApi.new
+id = 56 # Integer |
+
+begin
+  #Get Project By Id
+  result = api_instance.projects_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_get_count
+
+> Integer projects_get_count
+
+Get Projects Count
+
+Gets the count of all projects
+
+### 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::EntityProjectsApi.new
+
+begin
+  #Get Projects Count
+  result = api_instance.projects_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_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
+
+
+## projects_merge
+
+> Project2 projects_merge(id, merge_entity_instances_command_data)
+
+Merge Projects
+
+Merge existing projects.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+merge_entity_instances_command_data = CMV4APIClient::MergeEntityInstancesCommandData.new # MergeEntityInstancesCommandData |
+
+begin
+  #Merge Projects
+  result = api_instance.projects_merge(id, merge_entity_instances_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_merge: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **merge_entity_instances_command_data** | [**MergeEntityInstancesCommandData**](MergeEntityInstancesCommandData.md)|  |
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_modify
+
+> Project2 projects_modify(id, ensure_entity_instance_command_data)
+
+Modify a project
+
+Modify an existing project.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+ensure_entity_instance_command_data = {"DataVersion":0,"ProjectOperations":{"Relate":[0],"Unrelate":[0]},"Values":{"timeZone":"","currentcapacityml":0,"percentagefull":0,"fullsupplycapacityml":0,"notes":"","dateEnd":"2020-03-25T08:41:19","projectGroup":null,"name":"","dateStart":"2020-03-25T08:41:19"}} # EnsureEntityInstanceCommandData |
+
+begin
+  #Modify a project
+  result = api_instance.projects_modify(id, ensure_entity_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_entity_instance_command_data** | [**EnsureEntityInstanceCommandData**](EnsureEntityInstanceCommandData.md)|  |
+
+### Return type
+
+[**Project2**](Project2.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
+
+
+## projects_restore
+
+> Object projects_restore(id)
+
+Restore a project
+
+Restores a project.
+
+### 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::EntityProjectsApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a project
+  result = api_instance.projects_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling EntityProjectsApi->projects_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
+