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