Module: CMV4APIClient

Defined in:
lib/cmv4-openapi-client/version.rb,
lib/cmv4-openapi-client.rb,
lib/cmv4-openapi-client/api_error.rb,
lib/cmv4-openapi-client/api_client.rb,
lib/cmv4-openapi-client/models/team.rb,
lib/cmv4-openapi-client/models/user.rb,
lib/cmv4-openapi-client/models/claim.rb,
lib/cmv4-openapi-client/models/event.rb,
lib/cmv4-openapi-client/models/teams.rb,
lib/cmv4-openapi-client/models/users.rb,
lib/cmv4-openapi-client/configuration.rb,
lib/cmv4-openapi-client/models/action.rb,
lib/cmv4-openapi-client/models/change.rb,
lib/cmv4-openapi-client/models/events.rb,
lib/cmv4-openapi-client/models/actions.rb,
lib/cmv4-openapi-client/models/project.rb,
lib/cmv4-openapi-client/models/document.rb,
lib/cmv4-openapi-client/models/measures.rb,
lib/cmv4-openapi-client/models/project2.rb,
lib/cmv4-openapi-client/models/property.rb,
lib/cmv4-openapi-client/models/documents.rb,
lib/cmv4-openapi-client/models/change_log.rb,
lib/cmv4-openapi-client/models/field_type.rb,
lib/cmv4-openapi-client/models/i_modifier.rb,
lib/cmv4-openapi-client/models/membership.rb,
lib/cmv4-openapi-client/models/properties.rb,
lib/cmv4-openapi-client/models/stereotype.rb,
lib/cmv4-openapi-client/models/visibility.rb,
lib/cmv4-openapi-client/models/assigned_by.rb,
lib/cmv4-openapi-client/models/assigned_to.rb,
lib/cmv4-openapi-client/models/modify_data.rb,
lib/cmv4-openapi-client/models/stakeholder.rb,
lib/cmv4-openapi-client/models/field_nature.rb,
lib/cmv4-openapi-client/models/notification.rb,
lib/cmv4-openapi-client/models/organisation.rb,
lib/cmv4-openapi-client/models/stakeholders.rb,
lib/cmv4-openapi-client/api/entity_teams_api.rb,
lib/cmv4-openapi-client/api/entity_users_api.rb,
lib/cmv4-openapi-client/api/general_diff_api.rb,
lib/cmv4-openapi-client/models/address_model.rb,
lib/cmv4-openapi-client/models/organisations.rb,
lib/cmv4-openapi-client/models/query_request.rb,
lib/cmv4-openapi-client/models/related_value.rb,
lib/cmv4-openapi-client/api/entity_events_api.rb,
lib/cmv4-openapi-client/api/general_query_api.rb,
lib/cmv4-openapi-client/models/classification.rb,
lib/cmv4-openapi-client/models/correspondence.rb,
lib/cmv4-openapi-client/models/field_security.rb,
lib/cmv4-openapi-client/models/i_upload_token.rb,
lib/cmv4-openapi-client/models/identity_model.rb,
lib/cmv4-openapi-client/models/location_model.rb,
lib/cmv4-openapi-client/models/resource_model.rb,
lib/cmv4-openapi-client/models/search_request.rb,
lib/cmv4-openapi-client/api/entity_actions_api.rb,
lib/cmv4-openapi-client/api/general_search_api.rb,
lib/cmv4-openapi-client/models/i_system_policy.rb,
lib/cmv4-openapi-client/api/entity_projects_api.rb,
lib/cmv4-openapi-client/api/general_storage_api.rb,
lib/cmv4-openapi-client/models/license_policies.rb,
lib/cmv4-openapi-client/models/project_modified.rb,
lib/cmv4-openapi-client/models/stereotype_scope.rb,
lib/cmv4-openapi-client/api/entity_documents_api.rb,
lib/cmv4-openapi-client/api/general_features_api.rb,
lib/cmv4-openapi-client/api/general_security_api.rb,
lib/cmv4-openapi-client/models/entity_definition.rb,
lib/cmv4-openapi-client/models/project_operation.rb,
lib/cmv4-openapi-client/models/stakeholder_event.rb,
lib/cmv4-openapi-client/api/entity_properties_api.rb,
lib/cmv4-openapi-client/models/completion_request.rb,
lib/cmv4-openapi-client/models/event_organisation.rb,
lib/cmv4-openapi-client/models/field_access_level.rb,
lib/cmv4-openapi-client/api/general_definition_api.rb,
lib/cmv4-openapi-client/api/relationship_users_api.rb,
lib/cmv4-openapi-client/models/domain_object_types.rb,
lib/cmv4-openapi-client/models/i_entity_definition.rb,
lib/cmv4-openapi-client/models/relationship_format.rb,
lib/cmv4-openapi-client/models/reset_password_data.rb,
lib/cmv4-openapi-client/api/entity_stakeholders_api.rb,
lib/cmv4-openapi-client/models/classification_model.rb,
lib/cmv4-openapi-client/models/dictionary_of_object.rb,
lib/cmv4-openapi-client/models/domain_object_nature.rb,
lib/cmv4-openapi-client/models/forgot_password_data.rb,
lib/cmv4-openapi-client/models/i_identity_reference.rb,
lib/cmv4-openapi-client/models/stakeholder_property.rb,
lib/cmv4-openapi-client/models/stereotype_operation.rb,
lib/cmv4-openapi-client/models/storage_content_type.rb,
lib/cmv4-openapi-client/models/validator_definition.rb,
lib/cmv4-openapi-client/api/entity_organisations_api.rb,
lib/cmv4-openapi-client/models/i_security_constraint.rb,
lib/cmv4-openapi-client/models/property_organisation.rb,
lib/cmv4-openapi-client/models/search_results_format.rb,
lib/cmv4-openapi-client/api/entity_correspondence_api.rb,
lib/cmv4-openapi-client/api/general_history_search_api.rb,
lib/cmv4-openapi-client/models/action_calendar_request.rb,
lib/cmv4-openapi-client/models/event_user_relationship.rb,
lib/cmv4-openapi-client/models/relationship_definition.rb,
lib/cmv4-openapi-client/api/general_classifications_api.rb,
lib/cmv4-openapi-client/models/classification_set_model.rb,
lib/cmv4-openapi-client/models/ensure_team_command_data.rb,
lib/cmv4-openapi-client/models/ensure_user_command_data.rb,
lib/cmv4-openapi-client/models/enterprise_configuration.rb,
lib/cmv4-openapi-client/models/entity_definition_all_of.rb,
lib/cmv4-openapi-client/models/filtered_reports_request.rb,
lib/cmv4-openapi-client/models/stakeholder_organisation.rb,
lib/cmv4-openapi-client/api/relationship_memberships_api.rb,
lib/cmv4-openapi-client/api/security_controller_read_api.rb,
lib/cmv4-openapi-client/models/classification_view_model.rb,
lib/cmv4-openapi-client/models/domain_object_permissions.rb,
lib/cmv4-openapi-client/models/event_action_relationship.rb,
lib/cmv4-openapi-client/models/i_relationship_definition.rb,
lib/cmv4-openapi-client/api/relationship_stakeholders_api.rb,
lib/cmv4-openapi-client/models/document_user_relationship.rb,
lib/cmv4-openapi-client/models/property_user_relationship.rb,
lib/cmv4-openapi-client/api/general_available_projects_api.rb,
lib/cmv4-openapi-client/models/ensure_project_command_data.rb,
lib/cmv4-openapi-client/models/event_document_relationship.rb,
lib/cmv4-openapi-client/models/knowledge_base_object_types.rb,
lib/cmv4-openapi-client/models/property_event_relationship.rb,
lib/cmv4-openapi-client/models/action_document_relationship.rb,
lib/cmv4-openapi-client/models/property_action_relationship.rb,
lib/cmv4-openapi-client/models/domain_object_definition_base.rb,
lib/cmv4-openapi-client/models/user_stakeholder_relationship.rb,
lib/cmv4-openapi-client/models/concrete_enterprise_definition.rb,
lib/cmv4-openapi-client/models/property_document_relationship.rb,
lib/cmv4-openapi-client/models/relationship_definition_all_of.rb,
lib/cmv4-openapi-client/models/aggregate_growth_counts_request.rb,
lib/cmv4-openapi-client/api/general_organisational_settings_api.rb,
lib/cmv4-openapi-client/api/relationship_assigned_byactions_api.rb,
lib/cmv4-openapi-client/api/relationship_assigned_toactions_api.rb,
lib/cmv4-openapi-client/api/relationship_stakeholder_events_api.rb,
lib/cmv4-openapi-client/models/classification_view_model_all_of.rb,
lib/cmv4-openapi-client/models/affected_stakeholder_relationship.rb,
lib/cmv4-openapi-client/models/channel_message_notification_type.rb,
lib/cmv4-openapi-client/models/classification_statistics_request.rb,
lib/cmv4-openapi-client/models/document_stakeholder_relationship.rb,
lib/cmv4-openapi-client/models/enterprise_configuration_modified.rb,
lib/cmv4-openapi-client/models/i_enumerable_of_project_of_object.rb,
lib/cmv4-openapi-client/models/i_knowledge_base_field_definition.rb,
lib/cmv4-openapi-client/models/uncategorised_email_count_request.rb,
lib/cmv4-openapi-client/models/ensure_classification_command_data.rb,
lib/cmv4-openapi-client/models/grant_team_membership_command_data.rb,
lib/cmv4-openapi-client/models/total_active_entity_counts_request.rb,
lib/cmv4-openapi-client/models/ensure_entity_instance_command_data.rb,
lib/cmv4-openapi-client/models/merge_entity_instances_command_data.rb,
lib/cmv4-openapi-client/api/relationship_stakeholder_properties_api.rb,
lib/cmv4-openapi-client/models/domain_object_definition_base_all_of.rb,
lib/cmv4-openapi-client/models/reassign_classification_command_data.rb,
lib/cmv4-openapi-client/api/relationship_events_to_organisations_api.rb,
lib/cmv4-openapi-client/models/knowledge_base_object_definition_base.rb,
lib/cmv4-openapi-client/api/relationship_event_user_relationships_api.rb,
lib/cmv4-openapi-client/models/i_knowledge_base_data_object_definition.rb,
lib/cmv4-openapi-client/api/relationship_event_action_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_team_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_document_user_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_event_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_properties_to_organisations_api.rb,
lib/cmv4-openapi-client/api/relationship_property_user_relationships_api.rb,
lib/cmv4-openapi-client/models/ensure_classification_command_data_values.rb,
lib/cmv4-openapi-client/models/ensure_relationship_instance_command_data.rb,
lib/cmv4-openapi-client/models/stakeholder_interactions_for_user_request.rb,
lib/cmv4-openapi-client/api/relationship_action_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_event_document_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_property_event_relationships_api.rb,
lib/cmv4-openapi-client/models/i_knowledge_base_object_definition_feature.rb,
lib/cmv4-openapi-client/models/outstanding_actions_by_user_counts_request.rb,
lib/cmv4-openapi-client/api/relationship_action_document_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_property_action_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_stakeholders_to_organisations_api.rb,
lib/cmv4-openapi-client/api/relationship_document_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_property_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_user_stakeholder_relationships_api.rb,
lib/cmv4-openapi-client/models/i_read_only_knowledge_base_object_definition.rb,
lib/cmv4-openapi-client/api/relationship_property_document_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_stakeholder_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_affected_stakeholder_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_document_stakeholder_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_organisation_project_relationships_api.rb,
lib/cmv4-openapi-client/api/relationship_correspondence_project_relationships_api.rb

Overview

#Consultation Manager REST API

#The REST API for the Consultation Manager application

The version of the OpenAPI document: v1

Generated by: openapi-generator.tech OpenAPI Generator version: 4.2.3

Defined Under Namespace

Classes: Action, ActionCalendarRequest, ActionDocumentRelationship, Actions, AddressModel, AffectedStakeholderRelationship, AggregateGrowthCountsRequest, ApiClient, ApiError, AssignedBy, AssignedTo, Change, ChangeLog, ChannelMessageNotificationType, Claim, Classification, ClassificationModel, ClassificationSetModel, ClassificationStatisticsRequest, ClassificationViewModel, ClassificationViewModelAllOf, CompletionRequest, ConcreteEnterpriseDefinition, Configuration, Correspondence, DictionaryOfObject, Document, DocumentStakeholderRelationship, DocumentUserRelationship, Documents, DomainObjectDefinitionBase, DomainObjectDefinitionBaseAllOf, DomainObjectNature, DomainObjectPermissions, DomainObjectTypes, EnsureClassificationCommandData, EnsureClassificationCommandDataValues, EnsureEntityInstanceCommandData, EnsureProjectCommandData, EnsureRelationshipInstanceCommandData, EnsureTeamCommandData, EnsureUserCommandData, EnterpriseConfiguration, EnterpriseConfigurationModified, EntityActionsApi, EntityCorrespondenceApi, EntityDefinition, EntityDefinitionAllOf, EntityDocumentsApi, EntityEventsApi, EntityOrganisationsApi, EntityProjectsApi, EntityPropertiesApi, EntityStakeholdersApi, EntityTeamsApi, EntityUsersApi, Event, EventActionRelationship, EventDocumentRelationship, EventOrganisation, EventUserRelationship, Events, FieldAccessLevel, FieldNature, FieldSecurity, FieldType, FilteredReportsRequest, ForgotPasswordData, GeneralAvailableProjectsApi, GeneralClassificationsApi, GeneralDefinitionApi, GeneralDiffApi, GeneralFeaturesApi, GeneralHistorySearchApi, GeneralOrganisationalSettingsApi, GeneralQueryApi, GeneralSearchApi, GeneralSecurityApi, GeneralStorageApi, GrantTeamMembershipCommandData, IEntityDefinition, IEnumerableOfProjectOfObject, IIdentityReference, IKnowledgeBaseDataObjectDefinition, IKnowledgeBaseFieldDefinition, IKnowledgeBaseObjectDefinitionFeature, IModifier, IReadOnlyKnowledgeBaseObjectDefinition, IRelationshipDefinition, ISecurityConstraint, ISystemPolicy, IUploadToken, IdentityModel, KnowledgeBaseObjectDefinitionBase, KnowledgeBaseObjectTypes, LicensePolicies, LocationModel, Measures, Membership, MergeEntityInstancesCommandData, ModifyData, Notification, Organisation, Organisations, OutstandingActionsByUserCountsRequest, Project, Project2, ProjectModified, ProjectOperation, Properties, Property, PropertyActionRelationship, PropertyDocumentRelationship, PropertyEventRelationship, PropertyOrganisation, PropertyUserRelationship, QueryRequest, ReassignClassificationCommandData, RelatedValue, RelationshipActionDocumentRelationshipsApi, RelationshipActionProjectRelationshipsApi, RelationshipAffectedStakeholderRelationshipsApi, RelationshipAssignedByactionsApi, RelationshipAssignedToactionsApi, RelationshipCorrespondenceProjectRelationshipsApi, RelationshipDefinition, RelationshipDefinitionAllOf, RelationshipDocumentProjectRelationshipsApi, RelationshipDocumentStakeholderRelationshipsApi, RelationshipDocumentUserRelationshipsApi, RelationshipEventActionRelationshipsApi, RelationshipEventDocumentRelationshipsApi, RelationshipEventProjectRelationshipsApi, RelationshipEventUserRelationshipsApi, RelationshipEventsToOrganisationsApi, RelationshipFormat, RelationshipMembershipsApi, RelationshipOrganisationProjectRelationshipsApi, RelationshipPropertiesToOrganisationsApi, RelationshipPropertyActionRelationshipsApi, RelationshipPropertyDocumentRelationshipsApi, RelationshipPropertyEventRelationshipsApi, RelationshipPropertyProjectRelationshipsApi, RelationshipPropertyUserRelationshipsApi, RelationshipStakeholderEventsApi, RelationshipStakeholderProjectRelationshipsApi, RelationshipStakeholderPropertiesApi, RelationshipStakeholdersApi, RelationshipStakeholdersToOrganisationsApi, RelationshipTeamProjectRelationshipsApi, RelationshipUserStakeholderRelationshipsApi, RelationshipUsersApi, ResetPasswordData, ResourceModel, SearchRequest, SearchResultsFormat, SecurityControllerReadApi, Stakeholder, StakeholderEvent, StakeholderInteractionsForUserRequest, StakeholderOrganisation, StakeholderProperty, Stakeholders, Stereotype, StereotypeOperation, StereotypeScope, StorageContentType, Team, Teams, TotalActiveEntityCountsRequest, UncategorisedEmailCountRequest, User, UserStakeholderRelationship, Users, ValidatorDefinition, Visibility

Constant Summary collapse

VERSION = 
'1.0.3'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

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.



204
205
206
207
208
209
210
 
# File 'lib/cmv4-openapi-client.rb', line 204

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end