cmv4-openapi-client 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +606 -0
- data/Rakefile +10 -0
- data/build_gem.sh +2 -0
- data/cm4-openapi.config.json +6 -0
- data/cm4-openapi.yaml +14221 -0
- data/cmv4-openapi-client-1.0.1.gem +0 -0
- data/cmv4-openapi-client-1.0.2.gem +0 -0
- data/cmv4-openapi-client.gemspec +39 -0
- data/docs/Action.md +55 -0
- data/docs/ActionCalendarRequest.md +19 -0
- data/docs/ActionDocumentRelationship.md +35 -0
- data/docs/Actions.md +35 -0
- data/docs/AddressModel.md +29 -0
- data/docs/AffectedStakeholderRelationship.md +35 -0
- data/docs/AggregateGrowthCountsRequest.md +17 -0
- data/docs/AssignedBy.md +35 -0
- data/docs/AssignedTo.md +35 -0
- data/docs/Change.md +21 -0
- data/docs/ChangeLog.md +19 -0
- data/docs/ChannelMessageNotificationType.md +16 -0
- data/docs/Claim.md +19 -0
- data/docs/Classification.md +25 -0
- data/docs/ClassificationModel.md +25 -0
- data/docs/ClassificationSetModel.md +17 -0
- data/docs/ClassificationStatisticsRequest.md +21 -0
- data/docs/ClassificationViewModel.md +31 -0
- data/docs/ClassificationViewModelAllOf.md +21 -0
- data/docs/CompletionRequest.md +17 -0
- data/docs/ConcreteEnterpriseDefinition.md +19 -0
- data/docs/Correspondence.md +41 -0
- data/docs/DictionaryOfObject.md +19 -0
- data/docs/Document.md +45 -0
- data/docs/DocumentStakeholderRelationship.md +35 -0
- data/docs/DocumentUserRelationship.md +35 -0
- data/docs/Documents.md +35 -0
- data/docs/DomainObjectDefinitionBase.md +35 -0
- data/docs/DomainObjectDefinitionBaseAllOf.md +17 -0
- data/docs/DomainObjectNature.md +16 -0
- data/docs/DomainObjectPermissions.md +21 -0
- data/docs/DomainObjectTypes.md +16 -0
- data/docs/EnsureClassificationCommandData.md +17 -0
- data/docs/EnsureClassificationCommandDataValues.md +25 -0
- data/docs/EnsureEntityInstanceCommandData.md +21 -0
- data/docs/EnsureProjectCommandData.md +19 -0
- data/docs/EnsureRelationshipInstanceCommandData.md +21 -0
- data/docs/EnsureTeamCommandData.md +21 -0
- data/docs/EnsureUserCommandData.md +23 -0
- data/docs/EnterpriseConfiguration.md +25 -0
- data/docs/EnterpriseConfigurationModified.md +25 -0
- data/docs/EntityActionsApi.md +572 -0
- data/docs/EntityCorrespondenceApi.md +572 -0
- data/docs/EntityDefinition.md +39 -0
- data/docs/EntityDefinitionAllOf.md +21 -0
- data/docs/EntityDocumentsApi.md +572 -0
- data/docs/EntityEventsApi.md +572 -0
- data/docs/EntityOrganisationsApi.md +572 -0
- data/docs/EntityProjectsApi.md +572 -0
- data/docs/EntityPropertiesApi.md +572 -0
- data/docs/EntityStakeholdersApi.md +572 -0
- data/docs/EntityTeamsApi.md +572 -0
- data/docs/EntityUsersApi.md +572 -0
- data/docs/Event.md +75 -0
- data/docs/EventActionRelationship.md +35 -0
- data/docs/EventDocumentRelationship.md +35 -0
- data/docs/EventOrganisation.md +35 -0
- data/docs/EventUserRelationship.md +35 -0
- data/docs/Events.md +35 -0
- data/docs/FieldAccessLevel.md +16 -0
- data/docs/FieldNature.md +16 -0
- data/docs/FieldSecurity.md +19 -0
- data/docs/FieldType.md +16 -0
- data/docs/FilteredReportsRequest.md +25 -0
- data/docs/ForgotPasswordData.md +17 -0
- data/docs/GeneralAvailableProjectsApi.md +52 -0
- data/docs/GeneralClassificationsApi.md +545 -0
- data/docs/GeneralDefinitionApi.md +240 -0
- data/docs/GeneralDiffApi.md +64 -0
- data/docs/GeneralFeaturesApi.md +96 -0
- data/docs/GeneralHistorySearchApi.md +56 -0
- data/docs/GeneralOrganisationalSettingsApi.md +56 -0
- data/docs/GeneralQueryApi.md +56 -0
- data/docs/GeneralSearchApi.md +104 -0
- data/docs/GeneralSecurityApi.md +358 -0
- data/docs/GeneralStorageApi.md +110 -0
- data/docs/GrantTeamMembershipCommandData.md +19 -0
- data/docs/IEntityDefinition.md +17 -0
- data/docs/IEnumerableOfProjectOfObject.md +21 -0
- data/docs/IIdentityReference.md +21 -0
- data/docs/IKnowledgeBaseDataObjectDefinition.md +23 -0
- data/docs/IKnowledgeBaseFieldDefinition.md +37 -0
- data/docs/IKnowledgeBaseObjectDefinitionFeature.md +19 -0
- data/docs/IModifier.md +17 -0
- data/docs/IReadOnlyKnowledgeBaseObjectDefinition.md +37 -0
- data/docs/IRelationshipDefinition.md +23 -0
- data/docs/ISecurityConstraint.md +17 -0
- data/docs/ISystemPolicy.md +19 -0
- data/docs/IUploadToken.md +19 -0
- data/docs/IdentityModel.md +25 -0
- data/docs/KnowledgeBaseObjectDefinitionBase.md +33 -0
- data/docs/KnowledgeBaseObjectTypes.md +16 -0
- data/docs/LicensePolicies.md +16 -0
- data/docs/LocationModel.md +19 -0
- data/docs/Measures.md +16 -0
- data/docs/Membership.md +37 -0
- data/docs/MergeEntityInstancesCommandData.md +17 -0
- data/docs/ModifyData.md +19 -0
- data/docs/Notification.md +19 -0
- data/docs/Organisation.md +71 -0
- data/docs/Organisations.md +35 -0
- data/docs/OutstandingActionsByUserCountsRequest.md +19 -0
- data/docs/Project.md +21 -0
- data/docs/Project2.md +53 -0
- data/docs/ProjectModified.md +21 -0
- data/docs/ProjectOperation.md +19 -0
- data/docs/Properties.md +35 -0
- data/docs/Property.md +63 -0
- data/docs/PropertyActionRelationship.md +35 -0
- data/docs/PropertyDocumentRelationship.md +35 -0
- data/docs/PropertyEventRelationship.md +35 -0
- data/docs/PropertyOrganisation.md +35 -0
- data/docs/PropertyUserRelationship.md +35 -0
- data/docs/QueryRequest.md +23 -0
- data/docs/ReassignClassificationCommandData.md +17 -0
- data/docs/RelatedValue.md +19 -0
- data/docs/RelationshipActionDocumentRelationshipsApi.md +458 -0
- data/docs/RelationshipActionProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipAffectedStakeholderRelationshipsApi.md +458 -0
- data/docs/RelationshipAssignedByactionsApi.md +458 -0
- data/docs/RelationshipAssignedToactionsApi.md +458 -0
- data/docs/RelationshipCorrespondenceProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipDefinition.md +43 -0
- data/docs/RelationshipDefinitionAllOf.md +25 -0
- data/docs/RelationshipDocumentProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipDocumentStakeholderRelationshipsApi.md +458 -0
- data/docs/RelationshipDocumentUserRelationshipsApi.md +458 -0
- data/docs/RelationshipEventActionRelationshipsApi.md +458 -0
- data/docs/RelationshipEventDocumentRelationshipsApi.md +458 -0
- data/docs/RelationshipEventProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipEventUserRelationshipsApi.md +458 -0
- data/docs/RelationshipEventsToOrganisationsApi.md +458 -0
- data/docs/RelationshipFormat.md +16 -0
- data/docs/RelationshipMembershipsApi.md +458 -0
- data/docs/RelationshipOrganisationProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipPropertiesToOrganisationsApi.md +458 -0
- data/docs/RelationshipPropertyActionRelationshipsApi.md +458 -0
- data/docs/RelationshipPropertyDocumentRelationshipsApi.md +458 -0
- data/docs/RelationshipPropertyEventRelationshipsApi.md +458 -0
- data/docs/RelationshipPropertyProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipPropertyUserRelationshipsApi.md +458 -0
- data/docs/RelationshipStakeholderEventsApi.md +458 -0
- data/docs/RelationshipStakeholderProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipStakeholderPropertiesApi.md +458 -0
- data/docs/RelationshipStakeholdersApi.md +458 -0
- data/docs/RelationshipStakeholdersToOrganisationsApi.md +458 -0
- data/docs/RelationshipTeamProjectRelationshipsApi.md +458 -0
- data/docs/RelationshipUserStakeholderRelationshipsApi.md +458 -0
- data/docs/RelationshipUsersApi.md +458 -0
- data/docs/ResetPasswordData.md +19 -0
- data/docs/ResourceModel.md +27 -0
- data/docs/SearchRequest.md +37 -0
- data/docs/SearchResultsFormat.md +16 -0
- data/docs/SecurityControllerReadApi.md +55 -0
- data/docs/Stakeholder.md +99 -0
- data/docs/StakeholderEvent.md +37 -0
- data/docs/StakeholderInteractionsForUserRequest.md +17 -0
- data/docs/StakeholderOrganisation.md +37 -0
- data/docs/StakeholderProperty.md +37 -0
- data/docs/Stakeholders.md +39 -0
- data/docs/Stereotype.md +19 -0
- data/docs/StereotypeOperation.md +19 -0
- data/docs/StereotypeScope.md +16 -0
- data/docs/StorageContentType.md +16 -0
- data/docs/Team.md +41 -0
- data/docs/Teams.md +35 -0
- data/docs/TotalActiveEntityCountsRequest.md +17 -0
- data/docs/UncategorisedEmailCountRequest.md +17 -0
- data/docs/User.md +61 -0
- data/docs/UserStakeholderRelationship.md +35 -0
- data/docs/Users.md +39 -0
- data/docs/ValidatorDefinition.md +17 -0
- data/docs/Visibility.md +16 -0
- data/generate_gem.sh +2 -0
- data/git_push.sh +58 -0
- data/lib/cmv4-openapi-client/api/entity_actions_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_correspondence_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_documents_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_events_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_organisations_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_projects_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_properties_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_stakeholders_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_teams_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/entity_users_api.rb +654 -0
- data/lib/cmv4-openapi-client/api/general_available_projects_api.rb +78 -0
- data/lib/cmv4-openapi-client/api/general_classifications_api.rb +728 -0
- data/lib/cmv4-openapi-client/api/general_definition_api.rb +312 -0
- data/lib/cmv4-openapi-client/api/general_diff_api.rb +92 -0
- data/lib/cmv4-openapi-client/api/general_features_api.rb +134 -0
- data/lib/cmv4-openapi-client/api/general_history_search_api.rb +86 -0
- data/lib/cmv4-openapi-client/api/general_organisational_settings_api.rb +80 -0
- data/lib/cmv4-openapi-client/api/general_query_api.rb +86 -0
- data/lib/cmv4-openapi-client/api/general_search_api.rb +150 -0
- data/lib/cmv4-openapi-client/api/general_security_api.rb +483 -0
- data/lib/cmv4-openapi-client/api/general_storage_api.rb +156 -0
- data/lib/cmv4-openapi-client/api/relationship_action_document_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_action_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_affected_stakeholder_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_assigned_byactions_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_assigned_toactions_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_correspondence_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_document_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_document_stakeholder_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_document_user_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_event_action_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_event_document_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_event_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_event_user_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_events_to_organisations_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_memberships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_organisation_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_properties_to_organisations_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_property_action_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_property_document_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_property_event_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_property_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_property_user_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_stakeholder_events_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_stakeholder_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_stakeholder_properties_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_stakeholders_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_stakeholders_to_organisations_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_team_project_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_user_stakeholder_relationships_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/relationship_users_api.rb +522 -0
- data/lib/cmv4-openapi-client/api/security_controller_read_api.rb +84 -0
- data/lib/cmv4-openapi-client/api_client.rb +392 -0
- data/lib/cmv4-openapi-client/api_error.rb +57 -0
- data/lib/cmv4-openapi-client/configuration.rb +256 -0
- data/lib/cmv4-openapi-client/models/action.rb +388 -0
- data/lib/cmv4-openapi-client/models/action_calendar_request.rb +218 -0
- data/lib/cmv4-openapi-client/models/action_document_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/actions.rb +289 -0
- data/lib/cmv4-openapi-client/models/address_model.rb +267 -0
- data/lib/cmv4-openapi-client/models/affected_stakeholder_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/aggregate_growth_counts_request.rb +209 -0
- data/lib/cmv4-openapi-client/models/assigned_by.rb +289 -0
- data/lib/cmv4-openapi-client/models/assigned_to.rb +289 -0
- data/lib/cmv4-openapi-client/models/change.rb +227 -0
- data/lib/cmv4-openapi-client/models/change_log.rb +219 -0
- data/lib/cmv4-openapi-client/models/channel_message_notification_type.rb +42 -0
- data/lib/cmv4-openapi-client/models/claim.rb +217 -0
- data/lib/cmv4-openapi-client/models/classification.rb +245 -0
- data/lib/cmv4-openapi-client/models/classification_model.rb +244 -0
- data/lib/cmv4-openapi-client/models/classification_set_model.rb +209 -0
- data/lib/cmv4-openapi-client/models/classification_statistics_request.rb +229 -0
- data/lib/cmv4-openapi-client/models/classification_view_model.rb +280 -0
- data/lib/cmv4-openapi-client/models/classification_view_model_all_of.rb +224 -0
- data/lib/cmv4-openapi-client/models/completion_request.rb +207 -0
- data/lib/cmv4-openapi-client/models/concrete_enterprise_definition.rb +221 -0
- data/lib/cmv4-openapi-client/models/correspondence.rb +322 -0
- data/lib/cmv4-openapi-client/models/dictionary_of_object.rb +217 -0
- data/lib/cmv4-openapi-client/models/document.rb +342 -0
- data/lib/cmv4-openapi-client/models/document_stakeholder_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/document_user_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/documents.rb +289 -0
- data/lib/cmv4-openapi-client/models/domain_object_definition_base.rb +308 -0
- data/lib/cmv4-openapi-client/models/domain_object_definition_base_all_of.rb +206 -0
- data/lib/cmv4-openapi-client/models/domain_object_nature.rb +36 -0
- data/lib/cmv4-openapi-client/models/domain_object_permissions.rb +230 -0
- data/lib/cmv4-openapi-client/models/domain_object_types.rb +36 -0
- data/lib/cmv4-openapi-client/models/ensure_classification_command_data.rb +207 -0
- data/lib/cmv4-openapi-client/models/ensure_classification_command_data_values.rb +247 -0
- data/lib/cmv4-openapi-client/models/ensure_entity_instance_command_data.rb +229 -0
- data/lib/cmv4-openapi-client/models/ensure_project_command_data.rb +219 -0
- data/lib/cmv4-openapi-client/models/ensure_relationship_instance_command_data.rb +231 -0
- data/lib/cmv4-openapi-client/models/ensure_team_command_data.rb +229 -0
- data/lib/cmv4-openapi-client/models/ensure_user_command_data.rb +238 -0
- data/lib/cmv4-openapi-client/models/enterprise_configuration.rb +255 -0
- data/lib/cmv4-openapi-client/models/enterprise_configuration_modified.rb +247 -0
- data/lib/cmv4-openapi-client/models/entity_definition.rb +326 -0
- data/lib/cmv4-openapi-client/models/entity_definition_all_of.rb +224 -0
- data/lib/cmv4-openapi-client/models/event.rb +498 -0
- data/lib/cmv4-openapi-client/models/event_action_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/event_document_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/event_organisation.rb +289 -0
- data/lib/cmv4-openapi-client/models/event_user_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/events.rb +289 -0
- data/lib/cmv4-openapi-client/models/field_access_level.rb +38 -0
- data/lib/cmv4-openapi-client/models/field_nature.rb +37 -0
- data/lib/cmv4-openapi-client/models/field_security.rb +216 -0
- data/lib/cmv4-openapi-client/models/field_type.rb +52 -0
- data/lib/cmv4-openapi-client/models/filtered_reports_request.rb +249 -0
- data/lib/cmv4-openapi-client/models/forgot_password_data.rb +207 -0
- data/lib/cmv4-openapi-client/models/grant_team_membership_command_data.rb +216 -0
- data/lib/cmv4-openapi-client/models/i_entity_definition.rb +206 -0
- data/lib/cmv4-openapi-client/models/i_enumerable_of_project_of_object.rb +228 -0
- data/lib/cmv4-openapi-client/models/i_identity_reference.rb +227 -0
- data/lib/cmv4-openapi-client/models/i_knowledge_base_data_object_definition.rb +239 -0
- data/lib/cmv4-openapi-client/models/i_knowledge_base_field_definition.rb +308 -0
- data/lib/cmv4-openapi-client/models/i_knowledge_base_object_definition_feature.rb +216 -0
- data/lib/cmv4-openapi-client/models/i_modifier.rb +207 -0
- data/lib/cmv4-openapi-client/models/i_read_only_knowledge_base_object_definition.rb +312 -0
- data/lib/cmv4-openapi-client/models/i_relationship_definition.rb +236 -0
- data/lib/cmv4-openapi-client/models/i_security_constraint.rb +207 -0
- data/lib/cmv4-openapi-client/models/i_system_policy.rb +216 -0
- data/lib/cmv4-openapi-client/models/i_upload_token.rb +217 -0
- data/lib/cmv4-openapi-client/models/identity_model.rb +247 -0
- data/lib/cmv4-openapi-client/models/knowledge_base_object_definition_base.rb +291 -0
- data/lib/cmv4-openapi-client/models/knowledge_base_object_types.rb +37 -0
- data/lib/cmv4-openapi-client/models/license_policies.rb +37 -0
- data/lib/cmv4-openapi-client/models/location_model.rb +215 -0
- data/lib/cmv4-openapi-client/models/measures.rb +35 -0
- data/lib/cmv4-openapi-client/models/membership.rb +298 -0
- data/lib/cmv4-openapi-client/models/merge_entity_instances_command_data.rb +209 -0
- data/lib/cmv4-openapi-client/models/modify_data.rb +216 -0
- data/lib/cmv4-openapi-client/models/notification.rb +217 -0
- data/lib/cmv4-openapi-client/models/organisation.rb +471 -0
- data/lib/cmv4-openapi-client/models/organisations.rb +289 -0
- data/lib/cmv4-openapi-client/models/outstanding_actions_by_user_counts_request.rb +218 -0
- data/lib/cmv4-openapi-client/models/project.rb +226 -0
- data/lib/cmv4-openapi-client/models/project2.rb +375 -0
- data/lib/cmv4-openapi-client/models/project_modified.rb +228 -0
- data/lib/cmv4-openapi-client/models/project_operation.rb +221 -0
- data/lib/cmv4-openapi-client/models/properties.rb +289 -0
- data/lib/cmv4-openapi-client/models/property.rb +434 -0
- data/lib/cmv4-openapi-client/models/property_action_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/property_document_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/property_event_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/property_organisation.rb +289 -0
- data/lib/cmv4-openapi-client/models/property_user_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/query_request.rb +242 -0
- data/lib/cmv4-openapi-client/models/reassign_classification_command_data.rb +206 -0
- data/lib/cmv4-openapi-client/models/related_value.rb +216 -0
- data/lib/cmv4-openapi-client/models/relationship_definition.rb +347 -0
- data/lib/cmv4-openapi-client/models/relationship_definition_all_of.rb +245 -0
- data/lib/cmv4-openapi-client/models/relationship_format.rb +39 -0
- data/lib/cmv4-openapi-client/models/reset_password_data.rb +217 -0
- data/lib/cmv4-openapi-client/models/resource_model.rb +255 -0
- data/lib/cmv4-openapi-client/models/search_request.rb +313 -0
- data/lib/cmv4-openapi-client/models/search_results_format.rb +39 -0
- data/lib/cmv4-openapi-client/models/stakeholder.rb +607 -0
- data/lib/cmv4-openapi-client/models/stakeholder_event.rb +299 -0
- data/lib/cmv4-openapi-client/models/stakeholder_interactions_for_user_request.rb +209 -0
- data/lib/cmv4-openapi-client/models/stakeholder_organisation.rb +299 -0
- data/lib/cmv4-openapi-client/models/stakeholder_property.rb +299 -0
- data/lib/cmv4-openapi-client/models/stakeholders.rb +309 -0
- data/lib/cmv4-openapi-client/models/stereotype.rb +217 -0
- data/lib/cmv4-openapi-client/models/stereotype_operation.rb +221 -0
- data/lib/cmv4-openapi-client/models/stereotype_scope.rb +37 -0
- data/lib/cmv4-openapi-client/models/storage_content_type.rb +40 -0
- data/lib/cmv4-openapi-client/models/team.rb +322 -0
- data/lib/cmv4-openapi-client/models/teams.rb +289 -0
- data/lib/cmv4-openapi-client/models/total_active_entity_counts_request.rb +209 -0
- data/lib/cmv4-openapi-client/models/uncategorised_email_count_request.rb +209 -0
- data/lib/cmv4-openapi-client/models/user.rb +419 -0
- data/lib/cmv4-openapi-client/models/user_stakeholder_relationship.rb +289 -0
- data/lib/cmv4-openapi-client/models/users.rb +309 -0
- data/lib/cmv4-openapi-client/models/validator_definition.rb +207 -0
- data/lib/cmv4-openapi-client/models/visibility.rb +37 -0
- data/lib/cmv4-openapi-client/version.rb +15 -0
- data/lib/cmv4-openapi-client.rb +212 -0
- data/spec/api/entity_actions_api_spec.rb +157 -0
- data/spec/api/entity_correspondence_api_spec.rb +157 -0
- data/spec/api/entity_documents_api_spec.rb +157 -0
- data/spec/api/entity_events_api_spec.rb +157 -0
- data/spec/api/entity_organisations_api_spec.rb +157 -0
- data/spec/api/entity_projects_api_spec.rb +157 -0
- data/spec/api/entity_properties_api_spec.rb +157 -0
- data/spec/api/entity_stakeholders_api_spec.rb +157 -0
- data/spec/api/entity_teams_api_spec.rb +157 -0
- data/spec/api/entity_users_api_spec.rb +157 -0
- data/spec/api/general_available_projects_api_spec.rb +46 -0
- data/spec/api/general_classifications_api_spec.rb +172 -0
- data/spec/api/general_definition_api_spec.rb +93 -0
- data/spec/api/general_diff_api_spec.rb +50 -0
- data/spec/api/general_features_api_spec.rb +57 -0
- data/spec/api/general_history_search_api_spec.rb +47 -0
- data/spec/api/general_organisational_settings_api_spec.rb +47 -0
- data/spec/api/general_query_api_spec.rb +47 -0
- data/spec/api/general_search_api_spec.rb +59 -0
- data/spec/api/general_security_api_spec.rb +125 -0
- data/spec/api/general_storage_api_spec.rb +62 -0
- data/spec/api/relationship_action_document_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_action_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_affected_stakeholder_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_assigned_byactions_api_spec.rb +132 -0
- data/spec/api/relationship_assigned_toactions_api_spec.rb +132 -0
- data/spec/api/relationship_correspondence_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_document_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_document_stakeholder_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_document_user_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_event_action_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_event_document_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_event_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_event_user_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_events_to_organisations_api_spec.rb +132 -0
- data/spec/api/relationship_memberships_api_spec.rb +132 -0
- data/spec/api/relationship_organisation_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_properties_to_organisations_api_spec.rb +132 -0
- data/spec/api/relationship_property_action_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_property_document_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_property_event_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_property_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_property_user_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_stakeholder_events_api_spec.rb +132 -0
- data/spec/api/relationship_stakeholder_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_stakeholder_properties_api_spec.rb +132 -0
- data/spec/api/relationship_stakeholders_api_spec.rb +132 -0
- data/spec/api/relationship_stakeholders_to_organisations_api_spec.rb +132 -0
- data/spec/api/relationship_team_project_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_user_stakeholder_relationships_api_spec.rb +132 -0
- data/spec/api/relationship_users_api_spec.rb +132 -0
- data/spec/api/security_controller_read_api_spec.rb +46 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/action_calendar_request_spec.rb +47 -0
- data/spec/models/action_document_relationship_spec.rb +95 -0
- data/spec/models/action_spec.rb +155 -0
- data/spec/models/actions_spec.rb +95 -0
- data/spec/models/address_model_spec.rb +77 -0
- data/spec/models/affected_stakeholder_relationship_spec.rb +95 -0
- data/spec/models/aggregate_growth_counts_request_spec.rb +41 -0
- data/spec/models/assigned_by_spec.rb +95 -0
- data/spec/models/assigned_to_spec.rb +95 -0
- data/spec/models/change_log_spec.rb +47 -0
- data/spec/models/change_spec.rb +53 -0
- data/spec/models/channel_message_notification_type_spec.rb +35 -0
- data/spec/models/claim_spec.rb +47 -0
- data/spec/models/classification_model_spec.rb +65 -0
- data/spec/models/classification_set_model_spec.rb +41 -0
- data/spec/models/classification_spec.rb +65 -0
- data/spec/models/classification_statistics_request_spec.rb +53 -0
- data/spec/models/classification_view_model_all_of_spec.rb +53 -0
- data/spec/models/classification_view_model_spec.rb +83 -0
- data/spec/models/completion_request_spec.rb +41 -0
- data/spec/models/concrete_enterprise_definition_spec.rb +47 -0
- data/spec/models/correspondence_spec.rb +113 -0
- data/spec/models/dictionary_of_object_spec.rb +47 -0
- data/spec/models/document_spec.rb +125 -0
- data/spec/models/document_stakeholder_relationship_spec.rb +95 -0
- data/spec/models/document_user_relationship_spec.rb +95 -0
- data/spec/models/documents_spec.rb +95 -0
- data/spec/models/domain_object_definition_base_all_of_spec.rb +41 -0
- data/spec/models/domain_object_definition_base_spec.rb +95 -0
- data/spec/models/domain_object_nature_spec.rb +35 -0
- data/spec/models/domain_object_permissions_spec.rb +53 -0
- data/spec/models/domain_object_types_spec.rb +35 -0
- data/spec/models/ensure_classification_command_data_spec.rb +41 -0
- data/spec/models/ensure_classification_command_data_values_spec.rb +65 -0
- data/spec/models/ensure_entity_instance_command_data_spec.rb +53 -0
- data/spec/models/ensure_project_command_data_spec.rb +47 -0
- data/spec/models/ensure_relationship_instance_command_data_spec.rb +53 -0
- data/spec/models/ensure_team_command_data_spec.rb +53 -0
- data/spec/models/ensure_user_command_data_spec.rb +59 -0
- data/spec/models/enterprise_configuration_modified_spec.rb +65 -0
- data/spec/models/enterprise_configuration_spec.rb +65 -0
- data/spec/models/entity_definition_all_of_spec.rb +53 -0
- data/spec/models/entity_definition_spec.rb +107 -0
- data/spec/models/event_action_relationship_spec.rb +95 -0
- data/spec/models/event_document_relationship_spec.rb +95 -0
- data/spec/models/event_organisation_spec.rb +95 -0
- data/spec/models/event_spec.rb +215 -0
- data/spec/models/event_user_relationship_spec.rb +95 -0
- data/spec/models/events_spec.rb +95 -0
- data/spec/models/field_access_level_spec.rb +35 -0
- data/spec/models/field_nature_spec.rb +35 -0
- data/spec/models/field_security_spec.rb +47 -0
- data/spec/models/field_type_spec.rb +35 -0
- data/spec/models/filtered_reports_request_spec.rb +65 -0
- data/spec/models/forgot_password_data_spec.rb +41 -0
- data/spec/models/grant_team_membership_command_data_spec.rb +47 -0
- data/spec/models/i_entity_definition_spec.rb +41 -0
- data/spec/models/i_enumerable_of_project_of_object_spec.rb +53 -0
- data/spec/models/i_identity_reference_spec.rb +53 -0
- data/spec/models/i_knowledge_base_data_object_definition_spec.rb +59 -0
- data/spec/models/i_knowledge_base_field_definition_spec.rb +101 -0
- data/spec/models/i_knowledge_base_object_definition_feature_spec.rb +47 -0
- data/spec/models/i_modifier_spec.rb +41 -0
- data/spec/models/i_read_only_knowledge_base_object_definition_spec.rb +101 -0
- data/spec/models/i_relationship_definition_spec.rb +59 -0
- data/spec/models/i_security_constraint_spec.rb +41 -0
- data/spec/models/i_system_policy_spec.rb +47 -0
- data/spec/models/i_upload_token_spec.rb +47 -0
- data/spec/models/identity_model_spec.rb +65 -0
- data/spec/models/knowledge_base_object_definition_base_spec.rb +89 -0
- data/spec/models/knowledge_base_object_types_spec.rb +35 -0
- data/spec/models/license_policies_spec.rb +35 -0
- data/spec/models/location_model_spec.rb +47 -0
- data/spec/models/measures_spec.rb +35 -0
- data/spec/models/membership_spec.rb +101 -0
- data/spec/models/merge_entity_instances_command_data_spec.rb +41 -0
- data/spec/models/modify_data_spec.rb +47 -0
- data/spec/models/notification_spec.rb +47 -0
- data/spec/models/organisation_spec.rb +203 -0
- data/spec/models/organisations_spec.rb +95 -0
- data/spec/models/outstanding_actions_by_user_counts_request_spec.rb +47 -0
- data/spec/models/project2_spec.rb +149 -0
- data/spec/models/project_modified_spec.rb +53 -0
- data/spec/models/project_operation_spec.rb +47 -0
- data/spec/models/project_spec.rb +53 -0
- data/spec/models/properties_spec.rb +95 -0
- data/spec/models/property_action_relationship_spec.rb +95 -0
- data/spec/models/property_document_relationship_spec.rb +95 -0
- data/spec/models/property_event_relationship_spec.rb +95 -0
- data/spec/models/property_organisation_spec.rb +95 -0
- data/spec/models/property_spec.rb +179 -0
- data/spec/models/property_user_relationship_spec.rb +95 -0
- data/spec/models/query_request_spec.rb +59 -0
- data/spec/models/reassign_classification_command_data_spec.rb +41 -0
- data/spec/models/related_value_spec.rb +47 -0
- data/spec/models/relationship_definition_all_of_spec.rb +65 -0
- data/spec/models/relationship_definition_spec.rb +119 -0
- data/spec/models/relationship_format_spec.rb +35 -0
- data/spec/models/reset_password_data_spec.rb +47 -0
- data/spec/models/resource_model_spec.rb +71 -0
- data/spec/models/search_request_spec.rb +101 -0
- data/spec/models/search_results_format_spec.rb +35 -0
- data/spec/models/stakeholder_event_spec.rb +101 -0
- data/spec/models/stakeholder_interactions_for_user_request_spec.rb +41 -0
- data/spec/models/stakeholder_organisation_spec.rb +101 -0
- data/spec/models/stakeholder_property_spec.rb +101 -0
- data/spec/models/stakeholder_spec.rb +287 -0
- data/spec/models/stakeholders_spec.rb +107 -0
- data/spec/models/stereotype_operation_spec.rb +47 -0
- data/spec/models/stereotype_scope_spec.rb +35 -0
- data/spec/models/stereotype_spec.rb +47 -0
- data/spec/models/storage_content_type_spec.rb +35 -0
- data/spec/models/team_spec.rb +113 -0
- data/spec/models/teams_spec.rb +95 -0
- data/spec/models/total_active_entity_counts_request_spec.rb +41 -0
- data/spec/models/uncategorised_email_count_request_spec.rb +41 -0
- data/spec/models/user_spec.rb +173 -0
- data/spec/models/user_stakeholder_relationship_spec.rb +95 -0
- data/spec/models/users_spec.rb +107 -0
- data/spec/models/validator_definition_spec.rb +41 -0
- data/spec/models/visibility_spec.rb +35 -0
- data/spec/spec_helper.rb +111 -0
- data/test/client_test.rb +163 -0
- data/test/run_client_test.sh +2 -0
- metadata +819 -0
@@ -0,0 +1,654 @@
|
|
1
|
+
=begin
|
2
|
+
#Consultation Manager REST API
|
3
|
+
|
4
|
+
#The REST API for the Consultation Manager application
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module CMV4APIClient
|
16
|
+
class EntityOrganisationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Clone an existing organisation
|
23
|
+
# Clones an existing organisation.
|
24
|
+
# @param id [Integer]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Organisation]
|
27
|
+
def organisations_clone(id, opts = {})
|
28
|
+
data, _status_code, _headers = organisations_clone_with_http_info(id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Clone an existing organisation
|
33
|
+
# Clones an existing organisation.
|
34
|
+
# @param id [Integer]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
37
|
+
def organisations_clone_with_http_info(id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_clone ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'id' is set
|
42
|
+
if @api_client.config.client_side_validation && id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_clone"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/entities/organisation/{id}/clone'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:return_type] || 'Organisation'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:header_params => header_params,
|
70
|
+
:query_params => query_params,
|
71
|
+
:form_params => form_params,
|
72
|
+
:body => post_body,
|
73
|
+
:auth_names => auth_names,
|
74
|
+
:return_type => return_type
|
75
|
+
)
|
76
|
+
|
77
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
78
|
+
if @api_client.config.debugging
|
79
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
|
+
end
|
81
|
+
return data, status_code, headers
|
82
|
+
end
|
83
|
+
|
84
|
+
# Create a new organisation
|
85
|
+
# Creates a new organisation.
|
86
|
+
# @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
|
87
|
+
# @param [Hash] opts the optional parameters
|
88
|
+
# @return [Organisation]
|
89
|
+
def organisations_create(ensure_entity_instance_command_data, opts = {})
|
90
|
+
data, _status_code, _headers = organisations_create_with_http_info(ensure_entity_instance_command_data, opts)
|
91
|
+
data
|
92
|
+
end
|
93
|
+
|
94
|
+
# Create a new organisation
|
95
|
+
# Creates a new organisation.
|
96
|
+
# @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
|
97
|
+
# @param [Hash] opts the optional parameters
|
98
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
99
|
+
def organisations_create_with_http_info(ensure_entity_instance_command_data, opts = {})
|
100
|
+
if @api_client.config.debugging
|
101
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_create ...'
|
102
|
+
end
|
103
|
+
# verify the required parameter 'ensure_entity_instance_command_data' is set
|
104
|
+
if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
|
105
|
+
fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityOrganisationsApi.organisations_create"
|
106
|
+
end
|
107
|
+
# resource path
|
108
|
+
local_var_path = '/entities/organisation'
|
109
|
+
|
110
|
+
# query parameters
|
111
|
+
query_params = opts[:query_params] || {}
|
112
|
+
|
113
|
+
# header parameters
|
114
|
+
header_params = opts[:header_params] || {}
|
115
|
+
# HTTP header 'Accept' (if needed)
|
116
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
117
|
+
# HTTP header 'Content-Type'
|
118
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
119
|
+
|
120
|
+
# form parameters
|
121
|
+
form_params = opts[:form_params] || {}
|
122
|
+
|
123
|
+
# http body (model)
|
124
|
+
post_body = opts[:body] || @api_client.object_to_http_body(ensure_entity_instance_command_data)
|
125
|
+
|
126
|
+
# return_type
|
127
|
+
return_type = opts[:return_type] || 'Organisation'
|
128
|
+
|
129
|
+
# auth_names
|
130
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
131
|
+
|
132
|
+
new_options = opts.merge(
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names,
|
138
|
+
:return_type => return_type
|
139
|
+
)
|
140
|
+
|
141
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
142
|
+
if @api_client.config.debugging
|
143
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
|
+
end
|
145
|
+
return data, status_code, headers
|
146
|
+
end
|
147
|
+
|
148
|
+
# Delete a organisation
|
149
|
+
# Deletes an existing organisation.
|
150
|
+
# @param id [Integer]
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [Object]
|
153
|
+
def organisations_delete(id, opts = {})
|
154
|
+
data, _status_code, _headers = organisations_delete_with_http_info(id, opts)
|
155
|
+
data
|
156
|
+
end
|
157
|
+
|
158
|
+
# Delete a organisation
|
159
|
+
# Deletes an existing organisation.
|
160
|
+
# @param id [Integer]
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
163
|
+
def organisations_delete_with_http_info(id, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_delete ...'
|
166
|
+
end
|
167
|
+
# verify the required parameter 'id' is set
|
168
|
+
if @api_client.config.client_side_validation && id.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_delete"
|
170
|
+
end
|
171
|
+
# resource path
|
172
|
+
local_var_path = '/entities/organisation/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
173
|
+
|
174
|
+
# query parameters
|
175
|
+
query_params = opts[:query_params] || {}
|
176
|
+
|
177
|
+
# header parameters
|
178
|
+
header_params = opts[:header_params] || {}
|
179
|
+
# HTTP header 'Accept' (if needed)
|
180
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
181
|
+
|
182
|
+
# form parameters
|
183
|
+
form_params = opts[:form_params] || {}
|
184
|
+
|
185
|
+
# http body (model)
|
186
|
+
post_body = opts[:body]
|
187
|
+
|
188
|
+
# return_type
|
189
|
+
return_type = opts[:return_type] || 'Object'
|
190
|
+
|
191
|
+
# auth_names
|
192
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
193
|
+
|
194
|
+
new_options = opts.merge(
|
195
|
+
:header_params => header_params,
|
196
|
+
:query_params => query_params,
|
197
|
+
:form_params => form_params,
|
198
|
+
:body => post_body,
|
199
|
+
:auth_names => auth_names,
|
200
|
+
:return_type => return_type
|
201
|
+
)
|
202
|
+
|
203
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
204
|
+
if @api_client.config.debugging
|
205
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
206
|
+
end
|
207
|
+
return data, status_code, headers
|
208
|
+
end
|
209
|
+
|
210
|
+
# Delete a organisation
|
211
|
+
# Deletes an existing organisation.
|
212
|
+
# @param id [Integer]
|
213
|
+
# @param [Hash] opts the optional parameters
|
214
|
+
# @return [Object]
|
215
|
+
def organisations_delete_using_post(id, opts = {})
|
216
|
+
data, _status_code, _headers = organisations_delete_using_post_with_http_info(id, opts)
|
217
|
+
data
|
218
|
+
end
|
219
|
+
|
220
|
+
# Delete a organisation
|
221
|
+
# Deletes an existing organisation.
|
222
|
+
# @param id [Integer]
|
223
|
+
# @param [Hash] opts the optional parameters
|
224
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
225
|
+
def organisations_delete_using_post_with_http_info(id, opts = {})
|
226
|
+
if @api_client.config.debugging
|
227
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_delete_using_post ...'
|
228
|
+
end
|
229
|
+
# verify the required parameter 'id' is set
|
230
|
+
if @api_client.config.client_side_validation && id.nil?
|
231
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_delete_using_post"
|
232
|
+
end
|
233
|
+
# resource path
|
234
|
+
local_var_path = '/entities/organisation/{id}/delete'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
235
|
+
|
236
|
+
# query parameters
|
237
|
+
query_params = opts[:query_params] || {}
|
238
|
+
|
239
|
+
# header parameters
|
240
|
+
header_params = opts[:header_params] || {}
|
241
|
+
# HTTP header 'Accept' (if needed)
|
242
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
243
|
+
|
244
|
+
# form parameters
|
245
|
+
form_params = opts[:form_params] || {}
|
246
|
+
|
247
|
+
# http body (model)
|
248
|
+
post_body = opts[:body]
|
249
|
+
|
250
|
+
# return_type
|
251
|
+
return_type = opts[:return_type] || 'Object'
|
252
|
+
|
253
|
+
# auth_names
|
254
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
255
|
+
|
256
|
+
new_options = opts.merge(
|
257
|
+
:header_params => header_params,
|
258
|
+
:query_params => query_params,
|
259
|
+
:form_params => form_params,
|
260
|
+
:body => post_body,
|
261
|
+
:auth_names => auth_names,
|
262
|
+
:return_type => return_type
|
263
|
+
)
|
264
|
+
|
265
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
266
|
+
if @api_client.config.debugging
|
267
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_delete_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
268
|
+
end
|
269
|
+
return data, status_code, headers
|
270
|
+
end
|
271
|
+
|
272
|
+
# Get All Organisations
|
273
|
+
# Gets all organisations and allows for the results to be paged.
|
274
|
+
# @param [Hash] opts the optional parameters
|
275
|
+
# @option opts [Integer] :page
|
276
|
+
# @option opts [Integer] :page_size
|
277
|
+
# @return [Organisation]
|
278
|
+
def organisations_get_all(opts = {})
|
279
|
+
data, _status_code, _headers = organisations_get_all_with_http_info(opts)
|
280
|
+
data
|
281
|
+
end
|
282
|
+
|
283
|
+
# Get All Organisations
|
284
|
+
# Gets all organisations and allows for the results to be paged.
|
285
|
+
# @param [Hash] opts the optional parameters
|
286
|
+
# @option opts [Integer] :page
|
287
|
+
# @option opts [Integer] :page_size
|
288
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
289
|
+
def organisations_get_all_with_http_info(opts = {})
|
290
|
+
if @api_client.config.debugging
|
291
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_get_all ...'
|
292
|
+
end
|
293
|
+
# resource path
|
294
|
+
local_var_path = '/entities/organisation?{page}&{pageSize}'
|
295
|
+
|
296
|
+
# query parameters
|
297
|
+
query_params = opts[:query_params] || {}
|
298
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
299
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
300
|
+
|
301
|
+
# header parameters
|
302
|
+
header_params = opts[:header_params] || {}
|
303
|
+
# HTTP header 'Accept' (if needed)
|
304
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
305
|
+
|
306
|
+
# form parameters
|
307
|
+
form_params = opts[:form_params] || {}
|
308
|
+
|
309
|
+
# http body (model)
|
310
|
+
post_body = opts[:body]
|
311
|
+
|
312
|
+
# return_type
|
313
|
+
return_type = opts[:return_type] || 'Organisation'
|
314
|
+
|
315
|
+
# auth_names
|
316
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
317
|
+
|
318
|
+
new_options = opts.merge(
|
319
|
+
:header_params => header_params,
|
320
|
+
:query_params => query_params,
|
321
|
+
:form_params => form_params,
|
322
|
+
:body => post_body,
|
323
|
+
:auth_names => auth_names,
|
324
|
+
:return_type => return_type
|
325
|
+
)
|
326
|
+
|
327
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
328
|
+
if @api_client.config.debugging
|
329
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
330
|
+
end
|
331
|
+
return data, status_code, headers
|
332
|
+
end
|
333
|
+
|
334
|
+
# Get Organisation By Id
|
335
|
+
# Gets a single organisation by its Id
|
336
|
+
# @param id [Integer]
|
337
|
+
# @param [Hash] opts the optional parameters
|
338
|
+
# @return [Organisation]
|
339
|
+
def organisations_get_by_id(id, opts = {})
|
340
|
+
data, _status_code, _headers = organisations_get_by_id_with_http_info(id, opts)
|
341
|
+
data
|
342
|
+
end
|
343
|
+
|
344
|
+
# Get Organisation By Id
|
345
|
+
# Gets a single organisation by its Id
|
346
|
+
# @param id [Integer]
|
347
|
+
# @param [Hash] opts the optional parameters
|
348
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
349
|
+
def organisations_get_by_id_with_http_info(id, opts = {})
|
350
|
+
if @api_client.config.debugging
|
351
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_get_by_id ...'
|
352
|
+
end
|
353
|
+
# verify the required parameter 'id' is set
|
354
|
+
if @api_client.config.client_side_validation && id.nil?
|
355
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_get_by_id"
|
356
|
+
end
|
357
|
+
# resource path
|
358
|
+
local_var_path = '/entities/organisation/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
359
|
+
|
360
|
+
# query parameters
|
361
|
+
query_params = opts[:query_params] || {}
|
362
|
+
|
363
|
+
# header parameters
|
364
|
+
header_params = opts[:header_params] || {}
|
365
|
+
# HTTP header 'Accept' (if needed)
|
366
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
367
|
+
|
368
|
+
# form parameters
|
369
|
+
form_params = opts[:form_params] || {}
|
370
|
+
|
371
|
+
# http body (model)
|
372
|
+
post_body = opts[:body]
|
373
|
+
|
374
|
+
# return_type
|
375
|
+
return_type = opts[:return_type] || 'Organisation'
|
376
|
+
|
377
|
+
# auth_names
|
378
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
379
|
+
|
380
|
+
new_options = opts.merge(
|
381
|
+
:header_params => header_params,
|
382
|
+
:query_params => query_params,
|
383
|
+
:form_params => form_params,
|
384
|
+
:body => post_body,
|
385
|
+
:auth_names => auth_names,
|
386
|
+
:return_type => return_type
|
387
|
+
)
|
388
|
+
|
389
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
390
|
+
if @api_client.config.debugging
|
391
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
392
|
+
end
|
393
|
+
return data, status_code, headers
|
394
|
+
end
|
395
|
+
|
396
|
+
# Get Organisations Count
|
397
|
+
# Gets the count of all organisations
|
398
|
+
# @param [Hash] opts the optional parameters
|
399
|
+
# @return [Integer]
|
400
|
+
def organisations_get_count(opts = {})
|
401
|
+
data, _status_code, _headers = organisations_get_count_with_http_info(opts)
|
402
|
+
data
|
403
|
+
end
|
404
|
+
|
405
|
+
# Get Organisations Count
|
406
|
+
# Gets the count of all organisations
|
407
|
+
# @param [Hash] opts the optional parameters
|
408
|
+
# @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers
|
409
|
+
def organisations_get_count_with_http_info(opts = {})
|
410
|
+
if @api_client.config.debugging
|
411
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_get_count ...'
|
412
|
+
end
|
413
|
+
# resource path
|
414
|
+
local_var_path = '/entities/organisation/count'
|
415
|
+
|
416
|
+
# query parameters
|
417
|
+
query_params = opts[:query_params] || {}
|
418
|
+
|
419
|
+
# header parameters
|
420
|
+
header_params = opts[:header_params] || {}
|
421
|
+
# HTTP header 'Accept' (if needed)
|
422
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
423
|
+
|
424
|
+
# form parameters
|
425
|
+
form_params = opts[:form_params] || {}
|
426
|
+
|
427
|
+
# http body (model)
|
428
|
+
post_body = opts[:body]
|
429
|
+
|
430
|
+
# return_type
|
431
|
+
return_type = opts[:return_type] || 'Integer'
|
432
|
+
|
433
|
+
# auth_names
|
434
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
435
|
+
|
436
|
+
new_options = opts.merge(
|
437
|
+
:header_params => header_params,
|
438
|
+
:query_params => query_params,
|
439
|
+
:form_params => form_params,
|
440
|
+
:body => post_body,
|
441
|
+
:auth_names => auth_names,
|
442
|
+
:return_type => return_type
|
443
|
+
)
|
444
|
+
|
445
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
446
|
+
if @api_client.config.debugging
|
447
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_get_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
448
|
+
end
|
449
|
+
return data, status_code, headers
|
450
|
+
end
|
451
|
+
|
452
|
+
# Merge Organisations
|
453
|
+
# Merge existing organisations.
|
454
|
+
# @param id [Integer]
|
455
|
+
# @param merge_entity_instances_command_data [MergeEntityInstancesCommandData]
|
456
|
+
# @param [Hash] opts the optional parameters
|
457
|
+
# @return [Organisation]
|
458
|
+
def organisations_merge(id, merge_entity_instances_command_data, opts = {})
|
459
|
+
data, _status_code, _headers = organisations_merge_with_http_info(id, merge_entity_instances_command_data, opts)
|
460
|
+
data
|
461
|
+
end
|
462
|
+
|
463
|
+
# Merge Organisations
|
464
|
+
# Merge existing organisations.
|
465
|
+
# @param id [Integer]
|
466
|
+
# @param merge_entity_instances_command_data [MergeEntityInstancesCommandData]
|
467
|
+
# @param [Hash] opts the optional parameters
|
468
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
469
|
+
def organisations_merge_with_http_info(id, merge_entity_instances_command_data, opts = {})
|
470
|
+
if @api_client.config.debugging
|
471
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_merge ...'
|
472
|
+
end
|
473
|
+
# verify the required parameter 'id' is set
|
474
|
+
if @api_client.config.client_side_validation && id.nil?
|
475
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_merge"
|
476
|
+
end
|
477
|
+
# verify the required parameter 'merge_entity_instances_command_data' is set
|
478
|
+
if @api_client.config.client_side_validation && merge_entity_instances_command_data.nil?
|
479
|
+
fail ArgumentError, "Missing the required parameter 'merge_entity_instances_command_data' when calling EntityOrganisationsApi.organisations_merge"
|
480
|
+
end
|
481
|
+
# resource path
|
482
|
+
local_var_path = '/entities/organisation/{id}/merge'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
483
|
+
|
484
|
+
# query parameters
|
485
|
+
query_params = opts[:query_params] || {}
|
486
|
+
|
487
|
+
# header parameters
|
488
|
+
header_params = opts[:header_params] || {}
|
489
|
+
# HTTP header 'Accept' (if needed)
|
490
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
491
|
+
# HTTP header 'Content-Type'
|
492
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
493
|
+
|
494
|
+
# form parameters
|
495
|
+
form_params = opts[:form_params] || {}
|
496
|
+
|
497
|
+
# http body (model)
|
498
|
+
post_body = opts[:body] || @api_client.object_to_http_body(merge_entity_instances_command_data)
|
499
|
+
|
500
|
+
# return_type
|
501
|
+
return_type = opts[:return_type] || 'Organisation'
|
502
|
+
|
503
|
+
# auth_names
|
504
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
505
|
+
|
506
|
+
new_options = opts.merge(
|
507
|
+
:header_params => header_params,
|
508
|
+
:query_params => query_params,
|
509
|
+
:form_params => form_params,
|
510
|
+
:body => post_body,
|
511
|
+
:auth_names => auth_names,
|
512
|
+
:return_type => return_type
|
513
|
+
)
|
514
|
+
|
515
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
516
|
+
if @api_client.config.debugging
|
517
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
518
|
+
end
|
519
|
+
return data, status_code, headers
|
520
|
+
end
|
521
|
+
|
522
|
+
# Modify a organisation
|
523
|
+
# Modify an existing organisation.
|
524
|
+
# @param id [Integer]
|
525
|
+
# @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
|
526
|
+
# @param [Hash] opts the optional parameters
|
527
|
+
# @return [Organisation]
|
528
|
+
def organisations_modify(id, ensure_entity_instance_command_data, opts = {})
|
529
|
+
data, _status_code, _headers = organisations_modify_with_http_info(id, ensure_entity_instance_command_data, opts)
|
530
|
+
data
|
531
|
+
end
|
532
|
+
|
533
|
+
# Modify a organisation
|
534
|
+
# Modify an existing organisation.
|
535
|
+
# @param id [Integer]
|
536
|
+
# @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
|
537
|
+
# @param [Hash] opts the optional parameters
|
538
|
+
# @return [Array<(Organisation, Integer, Hash)>] Organisation data, response status code and response headers
|
539
|
+
def organisations_modify_with_http_info(id, ensure_entity_instance_command_data, opts = {})
|
540
|
+
if @api_client.config.debugging
|
541
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_modify ...'
|
542
|
+
end
|
543
|
+
# verify the required parameter 'id' is set
|
544
|
+
if @api_client.config.client_side_validation && id.nil?
|
545
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_modify"
|
546
|
+
end
|
547
|
+
# verify the required parameter 'ensure_entity_instance_command_data' is set
|
548
|
+
if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
|
549
|
+
fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityOrganisationsApi.organisations_modify"
|
550
|
+
end
|
551
|
+
# resource path
|
552
|
+
local_var_path = '/entities/organisation/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
553
|
+
|
554
|
+
# query parameters
|
555
|
+
query_params = opts[:query_params] || {}
|
556
|
+
|
557
|
+
# header parameters
|
558
|
+
header_params = opts[:header_params] || {}
|
559
|
+
# HTTP header 'Accept' (if needed)
|
560
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
561
|
+
# HTTP header 'Content-Type'
|
562
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
563
|
+
|
564
|
+
# form parameters
|
565
|
+
form_params = opts[:form_params] || {}
|
566
|
+
|
567
|
+
# http body (model)
|
568
|
+
post_body = opts[:body] || @api_client.object_to_http_body(ensure_entity_instance_command_data)
|
569
|
+
|
570
|
+
# return_type
|
571
|
+
return_type = opts[:return_type] || 'Organisation'
|
572
|
+
|
573
|
+
# auth_names
|
574
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
575
|
+
|
576
|
+
new_options = opts.merge(
|
577
|
+
:header_params => header_params,
|
578
|
+
:query_params => query_params,
|
579
|
+
:form_params => form_params,
|
580
|
+
:body => post_body,
|
581
|
+
:auth_names => auth_names,
|
582
|
+
:return_type => return_type
|
583
|
+
)
|
584
|
+
|
585
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
586
|
+
if @api_client.config.debugging
|
587
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_modify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
588
|
+
end
|
589
|
+
return data, status_code, headers
|
590
|
+
end
|
591
|
+
|
592
|
+
# Restore a organisation
|
593
|
+
# Restores a organisation.
|
594
|
+
# @param id [Integer]
|
595
|
+
# @param [Hash] opts the optional parameters
|
596
|
+
# @return [Object]
|
597
|
+
def organisations_restore(id, opts = {})
|
598
|
+
data, _status_code, _headers = organisations_restore_with_http_info(id, opts)
|
599
|
+
data
|
600
|
+
end
|
601
|
+
|
602
|
+
# Restore a organisation
|
603
|
+
# Restores a organisation.
|
604
|
+
# @param id [Integer]
|
605
|
+
# @param [Hash] opts the optional parameters
|
606
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
607
|
+
def organisations_restore_with_http_info(id, opts = {})
|
608
|
+
if @api_client.config.debugging
|
609
|
+
@api_client.config.logger.debug 'Calling API: EntityOrganisationsApi.organisations_restore ...'
|
610
|
+
end
|
611
|
+
# verify the required parameter 'id' is set
|
612
|
+
if @api_client.config.client_side_validation && id.nil?
|
613
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EntityOrganisationsApi.organisations_restore"
|
614
|
+
end
|
615
|
+
# resource path
|
616
|
+
local_var_path = '/entities/organisation/{id}/restore'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
617
|
+
|
618
|
+
# query parameters
|
619
|
+
query_params = opts[:query_params] || {}
|
620
|
+
|
621
|
+
# header parameters
|
622
|
+
header_params = opts[:header_params] || {}
|
623
|
+
# HTTP header 'Accept' (if needed)
|
624
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
625
|
+
|
626
|
+
# form parameters
|
627
|
+
form_params = opts[:form_params] || {}
|
628
|
+
|
629
|
+
# http body (model)
|
630
|
+
post_body = opts[:body]
|
631
|
+
|
632
|
+
# return_type
|
633
|
+
return_type = opts[:return_type] || 'Object'
|
634
|
+
|
635
|
+
# auth_names
|
636
|
+
auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
|
637
|
+
|
638
|
+
new_options = opts.merge(
|
639
|
+
:header_params => header_params,
|
640
|
+
:query_params => query_params,
|
641
|
+
:form_params => form_params,
|
642
|
+
:body => post_body,
|
643
|
+
:auth_names => auth_names,
|
644
|
+
:return_type => return_type
|
645
|
+
)
|
646
|
+
|
647
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
648
|
+
if @api_client.config.debugging
|
649
|
+
@api_client.config.logger.debug "API called: EntityOrganisationsApi#organisations_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
650
|
+
end
|
651
|
+
return data, status_code, headers
|
652
|
+
end
|
653
|
+
end
|
654
|
+
end
|