cmv4-openapi-client 1.0.3

data/lib/cmv4-openapi-client.rb

@@ -0,0 +1,212 @@
+=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
+
+# Common files
+require 'cmv4-openapi-client/api_client'
+require 'cmv4-openapi-client/api_error'
+require 'cmv4-openapi-client/version'
+require 'cmv4-openapi-client/configuration'
+
+# Models
+require 'cmv4-openapi-client/models/action'
+require 'cmv4-openapi-client/models/action_calendar_request'
+require 'cmv4-openapi-client/models/action_document_relationship'
+require 'cmv4-openapi-client/models/actions'
+require 'cmv4-openapi-client/models/address_model'
+require 'cmv4-openapi-client/models/affected_stakeholder_relationship'
+require 'cmv4-openapi-client/models/aggregate_growth_counts_request'
+require 'cmv4-openapi-client/models/assigned_by'
+require 'cmv4-openapi-client/models/assigned_to'
+require 'cmv4-openapi-client/models/change'
+require 'cmv4-openapi-client/models/change_log'
+require 'cmv4-openapi-client/models/channel_message_notification_type'
+require 'cmv4-openapi-client/models/claim'
+require 'cmv4-openapi-client/models/classification'
+require 'cmv4-openapi-client/models/classification_model'
+require 'cmv4-openapi-client/models/classification_set_model'
+require 'cmv4-openapi-client/models/classification_statistics_request'
+require 'cmv4-openapi-client/models/classification_view_model'
+require 'cmv4-openapi-client/models/classification_view_model_all_of'
+require 'cmv4-openapi-client/models/completion_request'
+require 'cmv4-openapi-client/models/concrete_enterprise_definition'
+require 'cmv4-openapi-client/models/correspondence'
+require 'cmv4-openapi-client/models/dictionary_of_object'
+require 'cmv4-openapi-client/models/document'
+require 'cmv4-openapi-client/models/document_stakeholder_relationship'
+require 'cmv4-openapi-client/models/document_user_relationship'
+require 'cmv4-openapi-client/models/documents'
+require 'cmv4-openapi-client/models/domain_object_definition_base'
+require 'cmv4-openapi-client/models/domain_object_definition_base_all_of'
+require 'cmv4-openapi-client/models/domain_object_nature'
+require 'cmv4-openapi-client/models/domain_object_permissions'
+require 'cmv4-openapi-client/models/domain_object_types'
+require 'cmv4-openapi-client/models/ensure_classification_command_data'
+require 'cmv4-openapi-client/models/ensure_classification_command_data_values'
+require 'cmv4-openapi-client/models/ensure_entity_instance_command_data'
+require 'cmv4-openapi-client/models/ensure_project_command_data'
+require 'cmv4-openapi-client/models/ensure_relationship_instance_command_data'
+require 'cmv4-openapi-client/models/ensure_team_command_data'
+require 'cmv4-openapi-client/models/ensure_user_command_data'
+require 'cmv4-openapi-client/models/enterprise_configuration'
+require 'cmv4-openapi-client/models/enterprise_configuration_modified'
+require 'cmv4-openapi-client/models/entity_definition'
+require 'cmv4-openapi-client/models/entity_definition_all_of'
+require 'cmv4-openapi-client/models/event'
+require 'cmv4-openapi-client/models/event_action_relationship'
+require 'cmv4-openapi-client/models/event_document_relationship'
+require 'cmv4-openapi-client/models/event_organisation'
+require 'cmv4-openapi-client/models/event_user_relationship'
+require 'cmv4-openapi-client/models/events'
+require 'cmv4-openapi-client/models/field_access_level'
+require 'cmv4-openapi-client/models/field_nature'
+require 'cmv4-openapi-client/models/field_security'
+require 'cmv4-openapi-client/models/field_type'
+require 'cmv4-openapi-client/models/filtered_reports_request'
+require 'cmv4-openapi-client/models/forgot_password_data'
+require 'cmv4-openapi-client/models/grant_team_membership_command_data'
+require 'cmv4-openapi-client/models/i_entity_definition'
+require 'cmv4-openapi-client/models/i_enumerable_of_project_of_object'
+require 'cmv4-openapi-client/models/i_identity_reference'
+require 'cmv4-openapi-client/models/i_knowledge_base_data_object_definition'
+require 'cmv4-openapi-client/models/i_knowledge_base_field_definition'
+require 'cmv4-openapi-client/models/i_knowledge_base_object_definition_feature'
+require 'cmv4-openapi-client/models/i_modifier'
+require 'cmv4-openapi-client/models/i_read_only_knowledge_base_object_definition'
+require 'cmv4-openapi-client/models/i_relationship_definition'
+require 'cmv4-openapi-client/models/i_security_constraint'
+require 'cmv4-openapi-client/models/i_system_policy'
+require 'cmv4-openapi-client/models/i_upload_token'
+require 'cmv4-openapi-client/models/identity_model'
+require 'cmv4-openapi-client/models/knowledge_base_object_definition_base'
+require 'cmv4-openapi-client/models/knowledge_base_object_types'
+require 'cmv4-openapi-client/models/license_policies'
+require 'cmv4-openapi-client/models/location_model'
+require 'cmv4-openapi-client/models/measures'
+require 'cmv4-openapi-client/models/membership'
+require 'cmv4-openapi-client/models/merge_entity_instances_command_data'
+require 'cmv4-openapi-client/models/modify_data'
+require 'cmv4-openapi-client/models/notification'
+require 'cmv4-openapi-client/models/organisation'
+require 'cmv4-openapi-client/models/organisations'
+require 'cmv4-openapi-client/models/outstanding_actions_by_user_counts_request'
+require 'cmv4-openapi-client/models/project'
+require 'cmv4-openapi-client/models/project2'
+require 'cmv4-openapi-client/models/project_modified'
+require 'cmv4-openapi-client/models/project_operation'
+require 'cmv4-openapi-client/models/properties'
+require 'cmv4-openapi-client/models/property'
+require 'cmv4-openapi-client/models/property_action_relationship'
+require 'cmv4-openapi-client/models/property_document_relationship'
+require 'cmv4-openapi-client/models/property_event_relationship'
+require 'cmv4-openapi-client/models/property_organisation'
+require 'cmv4-openapi-client/models/property_user_relationship'
+require 'cmv4-openapi-client/models/query_request'
+require 'cmv4-openapi-client/models/reassign_classification_command_data'
+require 'cmv4-openapi-client/models/related_value'
+require 'cmv4-openapi-client/models/relationship_definition'
+require 'cmv4-openapi-client/models/relationship_definition_all_of'
+require 'cmv4-openapi-client/models/relationship_format'
+require 'cmv4-openapi-client/models/reset_password_data'
+require 'cmv4-openapi-client/models/resource_model'
+require 'cmv4-openapi-client/models/search_request'
+require 'cmv4-openapi-client/models/search_results_format'
+require 'cmv4-openapi-client/models/stakeholder'
+require 'cmv4-openapi-client/models/stakeholder_event'
+require 'cmv4-openapi-client/models/stakeholder_interactions_for_user_request'
+require 'cmv4-openapi-client/models/stakeholder_organisation'
+require 'cmv4-openapi-client/models/stakeholder_property'
+require 'cmv4-openapi-client/models/stakeholders'
+require 'cmv4-openapi-client/models/stereotype'
+require 'cmv4-openapi-client/models/stereotype_operation'
+require 'cmv4-openapi-client/models/stereotype_scope'
+require 'cmv4-openapi-client/models/storage_content_type'
+require 'cmv4-openapi-client/models/team'
+require 'cmv4-openapi-client/models/teams'
+require 'cmv4-openapi-client/models/total_active_entity_counts_request'
+require 'cmv4-openapi-client/models/uncategorised_email_count_request'
+require 'cmv4-openapi-client/models/user'
+require 'cmv4-openapi-client/models/user_stakeholder_relationship'
+require 'cmv4-openapi-client/models/users'
+require 'cmv4-openapi-client/models/validator_definition'
+require 'cmv4-openapi-client/models/visibility'
+
+# APIs
+require 'cmv4-openapi-client/api/entity_actions_api'
+require 'cmv4-openapi-client/api/entity_correspondence_api'
+require 'cmv4-openapi-client/api/entity_documents_api'
+require 'cmv4-openapi-client/api/entity_events_api'
+require 'cmv4-openapi-client/api/entity_organisations_api'
+require 'cmv4-openapi-client/api/entity_projects_api'
+require 'cmv4-openapi-client/api/entity_properties_api'
+require 'cmv4-openapi-client/api/entity_stakeholders_api'
+require 'cmv4-openapi-client/api/entity_teams_api'
+require 'cmv4-openapi-client/api/entity_users_api'
+require 'cmv4-openapi-client/api/general_available_projects_api'
+require 'cmv4-openapi-client/api/general_classifications_api'
+require 'cmv4-openapi-client/api/general_definition_api'
+require 'cmv4-openapi-client/api/general_diff_api'
+require 'cmv4-openapi-client/api/general_features_api'
+require 'cmv4-openapi-client/api/general_history_search_api'
+require 'cmv4-openapi-client/api/general_organisational_settings_api'
+require 'cmv4-openapi-client/api/general_query_api'
+require 'cmv4-openapi-client/api/general_search_api'
+require 'cmv4-openapi-client/api/general_security_api'
+require 'cmv4-openapi-client/api/general_storage_api'
+require 'cmv4-openapi-client/api/relationship_action_document_relationships_api'
+require 'cmv4-openapi-client/api/relationship_action_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_affected_stakeholder_relationships_api'
+require 'cmv4-openapi-client/api/relationship_assigned_byactions_api'
+require 'cmv4-openapi-client/api/relationship_assigned_toactions_api'
+require 'cmv4-openapi-client/api/relationship_correspondence_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_document_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_document_stakeholder_relationships_api'
+require 'cmv4-openapi-client/api/relationship_document_user_relationships_api'
+require 'cmv4-openapi-client/api/relationship_event_action_relationships_api'
+require 'cmv4-openapi-client/api/relationship_event_document_relationships_api'
+require 'cmv4-openapi-client/api/relationship_event_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_event_user_relationships_api'
+require 'cmv4-openapi-client/api/relationship_events_to_organisations_api'
+require 'cmv4-openapi-client/api/relationship_memberships_api'
+require 'cmv4-openapi-client/api/relationship_organisation_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_properties_to_organisations_api'
+require 'cmv4-openapi-client/api/relationship_property_action_relationships_api'
+require 'cmv4-openapi-client/api/relationship_property_document_relationships_api'
+require 'cmv4-openapi-client/api/relationship_property_event_relationships_api'
+require 'cmv4-openapi-client/api/relationship_property_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_property_user_relationships_api'
+require 'cmv4-openapi-client/api/relationship_stakeholder_events_api'
+require 'cmv4-openapi-client/api/relationship_stakeholder_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_stakeholder_properties_api'
+require 'cmv4-openapi-client/api/relationship_stakeholders_api'
+require 'cmv4-openapi-client/api/relationship_stakeholders_to_organisations_api'
+require 'cmv4-openapi-client/api/relationship_team_project_relationships_api'
+require 'cmv4-openapi-client/api/relationship_user_stakeholder_relationships_api'
+require 'cmv4-openapi-client/api/relationship_users_api'
+require 'cmv4-openapi-client/api/security_controller_read_api'
+
+module CMV4APIClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CMV4APIClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/entity_actions_api_spec.rb

@@ -0,0 +1,157 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CMV4APIClient::EntityActionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EntityActionsApi' do
+  before do
+    # run before each test
+    @api_instance = CMV4APIClient::EntityActionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntityActionsApi' do
+    it 'should create an instance of EntityActionsApi' do
+      expect(@api_instance).to be_instance_of(CMV4APIClient::EntityActionsApi)
+    end
+  end
+
+  # unit tests for actions_clone
+  # Clone an existing action
+  # Clones an existing action.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'actions_clone test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_create
+  # Create a new action
+  # Creates a new action.
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'actions_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_delete
+  # Delete a action
+  # Deletes an existing action.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'actions_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_delete_using_post
+  # Delete a action
+  # Deletes an existing action.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'actions_delete_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_get_all
+  # Get All Actions
+  # Gets all actions and allows for the results to be paged.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page
+  # @option opts [Integer] :page_size
+  # @return [Action]
+  describe 'actions_get_all test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_get_by_id
+  # Get Action By Id
+  # Gets a single action by its Id
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'actions_get_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_get_count
+  # Get Actions Count
+  # Gets the count of all actions
+  # @param [Hash] opts the optional parameters
+  # @return [Integer]
+  describe 'actions_get_count test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_merge
+  # Merge Actions
+  # Merge existing actions.
+  # @param id
+  # @param merge_entity_instances_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'actions_merge test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_modify
+  # Modify a action
+  # Modify an existing action.
+  # @param id
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'actions_modify test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for actions_restore
+  # Restore a action
+  # Restores a action.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'actions_restore test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/entity_correspondence_api_spec.rb

@@ -0,0 +1,157 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CMV4APIClient::EntityCorrespondenceApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EntityCorrespondenceApi' do
+  before do
+    # run before each test
+    @api_instance = CMV4APIClient::EntityCorrespondenceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntityCorrespondenceApi' do
+    it 'should create an instance of EntityCorrespondenceApi' do
+      expect(@api_instance).to be_instance_of(CMV4APIClient::EntityCorrespondenceApi)
+    end
+  end
+
+  # unit tests for correspondence_clone
+  # Clone an existing correspondence
+  # Clones an existing correspondence.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Correspondence]
+  describe 'correspondence_clone test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_create
+  # Create a new correspondence
+  # Creates a new correspondence.
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Correspondence]
+  describe 'correspondence_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_delete
+  # Delete a correspondence
+  # Deletes an existing correspondence.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'correspondence_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_delete_using_post
+  # Delete a correspondence
+  # Deletes an existing correspondence.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'correspondence_delete_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_get_all
+  # Get All Correspondence
+  # Gets all correspondence and allows for the results to be paged.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page
+  # @option opts [Integer] :page_size
+  # @return [Correspondence]
+  describe 'correspondence_get_all test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_get_by_id
+  # Get Correspondence By Id
+  # Gets a single correspondence by its Id
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Correspondence]
+  describe 'correspondence_get_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_get_count
+  # Get Correspondence Count
+  # Gets the count of all correspondence
+  # @param [Hash] opts the optional parameters
+  # @return [Integer]
+  describe 'correspondence_get_count test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_merge
+  # Merge Correspondence
+  # Merge existing correspondence.
+  # @param id
+  # @param merge_entity_instances_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Correspondence]
+  describe 'correspondence_merge test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_modify
+  # Modify a correspondence
+  # Modify an existing correspondence.
+  # @param id
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Correspondence]
+  describe 'correspondence_modify test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for correspondence_restore
+  # Restore a correspondence
+  # Restores a correspondence.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'correspondence_restore test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/entity_documents_api_spec.rb

@@ -0,0 +1,157 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CMV4APIClient::EntityDocumentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EntityDocumentsApi' do
+  before do
+    # run before each test
+    @api_instance = CMV4APIClient::EntityDocumentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntityDocumentsApi' do
+    it 'should create an instance of EntityDocumentsApi' do
+      expect(@api_instance).to be_instance_of(CMV4APIClient::EntityDocumentsApi)
+    end
+  end
+
+  # unit tests for documents_clone
+  # Clone an existing document
+  # Clones an existing document.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Document]
+  describe 'documents_clone test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_create
+  # Create a new document
+  # Creates a new document.
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Document]
+  describe 'documents_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_delete
+  # Delete a document
+  # Deletes an existing document.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'documents_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_delete_using_post
+  # Delete a document
+  # Deletes an existing document.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'documents_delete_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_get_all
+  # Get All Documents
+  # Gets all documents and allows for the results to be paged.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page
+  # @option opts [Integer] :page_size
+  # @return [Document]
+  describe 'documents_get_all test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_get_by_id
+  # Get Document By Id
+  # Gets a single document by its Id
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Document]
+  describe 'documents_get_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_get_count
+  # Get Documents Count
+  # Gets the count of all documents
+  # @param [Hash] opts the optional parameters
+  # @return [Integer]
+  describe 'documents_get_count test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_merge
+  # Merge Documents
+  # Merge existing documents.
+  # @param id
+  # @param merge_entity_instances_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Document]
+  describe 'documents_merge test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_modify
+  # Modify a document
+  # Modify an existing document.
+  # @param id
+  # @param ensure_entity_instance_command_data
+  # @param [Hash] opts the optional parameters
+  # @return [Document]
+  describe 'documents_modify test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for documents_restore
+  # Restore a document
+  # Restores a document.
+  # @param id
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'documents_restore test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end