cmv4-openapi-client 1.0.3

data/cmv4-openapi-client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Consultation Manager REST API
+
+#The REST API for the Consultation Manager application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cmv4-openapi-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cmv4-openapi-client"
+  s.version     = CMV4APIClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Consultation Manager / Social Pinpoint"]
+  s.email       = ["developers@consultationmanager.com"]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Consultation Manager REST API Ruby Gem"
+  s.description = "The REST API for the Consultation Manager application"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Action.md

@@ -0,0 +1,55 @@
+# CMV4APIClient::Action
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional]
+**action_requested** | **String** |  | [optional]
+**action_status** | [**ClassificationModel**](ClassificationModel.md) |  | [optional]
+**action_taken** | **String** |  | [optional]
+**assigned_byaction** | [**RelatedValue**](RelatedValue.md) |  | [optional]
+**assigned_toaction** | [**RelatedValue**](RelatedValue.md) |  | [optional]
+**created** | **DateTime** |  | [optional]
+**created_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**database_id** | **String** |  | [optional]
+**deadline** | **DateTime** |  | [optional]
+**deleted** | **Boolean** |  | [optional]
+**descriptor** | **String** |  | [optional]
+**initiated** | **DateTime** |  | [optional]
+**modified** | **DateTime** |  | [optional]
+**modified_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**modified_end_time** | **DateTime** |  | [optional]
+**notified** | **DateTime** |  | [optional]
+**related_projects** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**resolved** | **DateTime** |  | [optional]
+**visibility** | **Integer** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::Action.new(id: null,
+                                 action_requested: null,
+                                 action_status: null,
+                                 action_taken: null,
+                                 assigned_byaction: null,
+                                 assigned_toaction: null,
+                                 created: null,
+                                 created_by: null,
+                                 database_id: null,
+                                 deadline: null,
+                                 deleted: null,
+                                 descriptor: null,
+                                 initiated: null,
+                                 modified: null,
+                                 modified_by: null,
+                                 modified_end_time: null,
+                                 notified: null,
+                                 related_projects: null,
+                                 resolved: null,
+                                 visibility: null)
+```
+
+

data/docs/ActionCalendarRequest.md

@@ -0,0 +1,19 @@
+# CMV4APIClient::ActionCalendarRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_ids** | **Array<Integer>** |  | [optional] 
+**user** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ActionCalendarRequest.new(project_ids: null,
+                                 user: null)
+```
+
+

data/docs/ActionDocumentRelationship.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::ActionDocumentRelationship
+
+## 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::ActionDocumentRelationship.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/Actions.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::Actions
+
+## 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::Actions.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/AddressModel.md

@@ -0,0 +1,29 @@
+# CMV4APIClient::AddressModel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** |  | [optional]
+**country** | **String** |  | [optional]
+**date_geocoded** | **DateTime** |  | [optional]
+**location** | [**LocationModel**](LocationModel.md) |  | [optional]
+**post_code** | **String** |  | [optional]
+**state** | **String** |  | [optional]
+**suburb** | **String** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::AddressModel.new(address: null,
+                                 country: null,
+                                 date_geocoded: null,
+                                 location: null,
+                                 post_code: null,
+                                 state: null,
+                                 suburb: null)
+```
+
+

data/docs/AffectedStakeholderRelationship.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::AffectedStakeholderRelationship
+
+## 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::AffectedStakeholderRelationship.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/AggregateGrowthCountsRequest.md

@@ -0,0 +1,17 @@
+# CMV4APIClient::AggregateGrowthCountsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_ids** | **Array<Integer>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::AggregateGrowthCountsRequest.new(project_ids: null)
+```
+
+

data/docs/AssignedBy.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::AssignedBy
+
+## 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::AssignedBy.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/AssignedTo.md

@@ -0,0 +1,35 @@
+# CMV4APIClient::AssignedTo
+
+## 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::AssignedTo.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/Change.md

@@ -0,0 +1,21 @@
+# CMV4APIClient::Change
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_alias** | **String** |  | [optional] 
+**from** | **Object** |  | [optional] 
+**to** | **Object** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::Change.new(_alias: null,
+                                 from: null,
+                                 to: null)
+```
+
+

data/docs/ChangeLog.md

@@ -0,0 +1,19 @@
+# CMV4APIClient::ChangeLog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**changes** | [**Array<Change>**](Change.md) |  | [optional]
+**modify_data** | [**ModifyData**](ModifyData.md) |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ChangeLog.new(changes: null,
+                                 modify_data: null)
+```
+
+

data/docs/ChannelMessageNotificationType.md

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

data/docs/Claim.md

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

data/docs/Classification.md

@@ -0,0 +1,25 @@
+# CMV4APIClient::Classification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**deleted** | **Boolean** |  | [optional] 
+**description** | **String** |  | [optional] 
+**hierarchy** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::Classification.new(id: null,
+                                 deleted: null,
+                                 description: null,
+                                 hierarchy: null,
+                                 name: null)
+```
+
+

data/docs/ClassificationModel.md

@@ -0,0 +1,25 @@
+# CMV4APIClient::ClassificationModel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**deleted** | **Boolean** |  | [optional] 
+**hierarchy** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**visibility** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ClassificationModel.new(id: null,
+                                 deleted: null,
+                                 hierarchy: null,
+                                 name: null,
+                                 visibility: null)
+```
+
+

data/docs/ClassificationSetModel.md

@@ -0,0 +1,17 @@
+# CMV4APIClient::ClassificationSetModel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | [**Array<ClassificationModel>**](ClassificationModel.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ClassificationSetModel.new(values: null)
+```
+
+

data/docs/ClassificationStatisticsRequest.md

@@ -0,0 +1,21 @@
+# CMV4APIClient::ClassificationStatisticsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **String** |  | [optional] 
+**field** | **String** |  | [optional] 
+**project_ids** | **Array<Integer>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ClassificationStatisticsRequest.new(entity: null,
+                                 field: null,
+                                 project_ids: null)
+```
+
+

data/docs/ClassificationViewModel.md

@@ -0,0 +1,31 @@
+# CMV4APIClient::ClassificationViewModel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**deleted** | **Boolean** |  | [optional] 
+**description** | **String** |  | [optional] 
+**hierarchy** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**is_leaf** | **Boolean** |  | [optional] 
+**selected** | **Integer** |  | [optional] 
+**visibility** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ClassificationViewModel.new(id: null,
+                                 deleted: null,
+                                 description: null,
+                                 hierarchy: null,
+                                 name: null,
+                                 is_leaf: null,
+                                 selected: null,
+                                 visibility: null)
+```
+
+

data/docs/ClassificationViewModelAllOf.md

@@ -0,0 +1,21 @@
+# CMV4APIClient::ClassificationViewModelAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_leaf** | **Boolean** |  | [optional] 
+**selected** | **Integer** |  | [optional] 
+**visibility** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ClassificationViewModelAllOf.new(is_leaf: null,
+                                 selected: null,
+                                 visibility: null)
+```
+
+

data/docs/CompletionRequest.md

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

data/docs/ConcreteEnterpriseDefinition.md

@@ -0,0 +1,19 @@
+# CMV4APIClient::ConcreteEnterpriseDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entities** | [**Array<EntityDefinition>**](EntityDefinition.md) |  | [optional] 
+**relationships** | [**Array<RelationshipDefinition>**](RelationshipDefinition.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::ConcreteEnterpriseDefinition.new(entities: null,
+                                 relationships: null)
+```
+
+

data/docs/Correspondence.md

@@ -0,0 +1,41 @@
+# CMV4APIClient::Correspondence
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional]
+**configuration** | **String** |  | [optional]
+**created** | **DateTime** |  | [optional]
+**created_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**database_id** | **String** |  | [optional]
+**deleted** | **Boolean** |  | [optional]
+**descriptor** | **String** |  | [optional]
+**modified** | **DateTime** |  | [optional]
+**modified_by** | [**IdentityModel**](IdentityModel.md) |  | [optional]
+**modified_end_time** | **DateTime** |  | [optional]
+**related_projects** | [**Array<RelatedValue>**](RelatedValue.md) |  | [optional]
+**type** | [**ClassificationModel**](ClassificationModel.md) |  | [optional]
+**visibility** | **Integer** |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'CMV4APIClient'
+
+instance = CMV4APIClient::Correspondence.new(id: null,
+                                 configuration: null,
+                                 created: null,
+                                 created_by: null,
+                                 database_id: null,
+                                 deleted: null,
+                                 descriptor: null,
+                                 modified: null,
+                                 modified_by: null,
+                                 modified_end_time: null,
+                                 related_projects: null,
+                                 type: null,
+                                 visibility: null)
+```
+
+

data/docs/DictionaryOfObject.md

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