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,239 @@
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 'date'
14
+
15
+ module CMV4APIClient
16
+ class IKnowledgeBaseDataObjectDefinition
17
+ attr_accessor :_alias
18
+
19
+ attr_accessor :field_definition_set
20
+
21
+ attr_accessor :name
22
+
23
+ attr_accessor :plural_name
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'_alias' => :'alias',
29
+ :'field_definition_set' => :'fieldDefinitionSet',
30
+ :'name' => :'name',
31
+ :'plural_name' => :'pluralName'
32
+ }
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.openapi_types
37
+ {
38
+ :'_alias' => :'String',
39
+ :'field_definition_set' => :'Hash<String, IKnowledgeBaseFieldDefinition>',
40
+ :'name' => :'String',
41
+ :'plural_name' => :'String'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ :'_alias',
49
+ :'field_definition_set',
50
+ :'name',
51
+ :'plural_name'
52
+ ])
53
+ end
54
+
55
+ # Initializes the object
56
+ # @param [Hash] attributes Model attributes in the form of hash
57
+ def initialize(attributes = {})
58
+ if (!attributes.is_a?(Hash))
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CMV4APIClient::IKnowledgeBaseDataObjectDefinition` initialize method"
60
+ end
61
+
62
+ # check to see if the attribute exists and convert string to symbol for hash key
63
+ attributes = attributes.each_with_object({}) { |(k, v), h|
64
+ if (!self.class.attribute_map.key?(k.to_sym))
65
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CMV4APIClient::IKnowledgeBaseDataObjectDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
66
+ end
67
+ h[k.to_sym] = v
68
+ }
69
+
70
+ if attributes.key?(:'_alias')
71
+ self._alias = attributes[:'_alias']
72
+ end
73
+
74
+ if attributes.key?(:'field_definition_set')
75
+ if (value = attributes[:'field_definition_set']).is_a?(Hash)
76
+ self.field_definition_set = value
77
+ end
78
+ end
79
+
80
+ if attributes.key?(:'name')
81
+ self.name = attributes[:'name']
82
+ end
83
+
84
+ if attributes.key?(:'plural_name')
85
+ self.plural_name = attributes[:'plural_name']
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ invalid_properties = Array.new
93
+ invalid_properties
94
+ end
95
+
96
+ # Check to see if the all the properties in the model are valid
97
+ # @return true if the model is valid
98
+ def valid?
99
+ true
100
+ end
101
+
102
+ # Checks equality by comparing each attribute.
103
+ # @param [Object] Object to be compared
104
+ def ==(o)
105
+ return true if self.equal?(o)
106
+ self.class == o.class &&
107
+ _alias == o._alias &&
108
+ field_definition_set == o.field_definition_set &&
109
+ name == o.name &&
110
+ plural_name == o.plural_name
111
+ end
112
+
113
+ # @see the `==` method
114
+ # @param [Object] Object to be compared
115
+ def eql?(o)
116
+ self == o
117
+ end
118
+
119
+ # Calculates hash code according to all attributes.
120
+ # @return [Integer] Hash code
121
+ def hash
122
+ [_alias, field_definition_set, name, plural_name].hash
123
+ end
124
+
125
+ # Builds the object from hash
126
+ # @param [Hash] attributes Model attributes in the form of hash
127
+ # @return [Object] Returns the model itself
128
+ def self.build_from_hash(attributes)
129
+ new.build_from_hash(attributes)
130
+ end
131
+
132
+ # Builds the object from hash
133
+ # @param [Hash] attributes Model attributes in the form of hash
134
+ # @return [Object] Returns the model itself
135
+ def build_from_hash(attributes)
136
+ return nil unless attributes.is_a?(Hash)
137
+ self.class.openapi_types.each_pair do |key, type|
138
+ if type =~ /\AArray<(.*)>/i
139
+ # check to ensure the input is an array given that the attribute
140
+ # is documented as an array but the input is not
141
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
142
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
143
+ end
144
+ elsif !attributes[self.class.attribute_map[key]].nil?
145
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
146
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
147
+ end
148
+
149
+ self
150
+ end
151
+
152
+ # Deserializes the data based on type
153
+ # @param string type Data type
154
+ # @param string value Value to be deserialized
155
+ # @return [Object] Deserialized data
156
+ def _deserialize(type, value)
157
+ case type.to_sym
158
+ when :DateTime
159
+ DateTime.parse(value)
160
+ when :Date
161
+ Date.parse(value)
162
+ when :String
163
+ value.to_s
164
+ when :Integer
165
+ value.to_i
166
+ when :Float
167
+ value.to_f
168
+ when :Boolean
169
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
170
+ true
171
+ else
172
+ false
173
+ end
174
+ when :Object
175
+ # generic object (usually a Hash), return directly
176
+ value
177
+ when /\AArray<(?<inner_type>.+)>\z/
178
+ inner_type = Regexp.last_match[:inner_type]
179
+ value.map { |v| _deserialize(inner_type, v) }
180
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
181
+ k_type = Regexp.last_match[:k_type]
182
+ v_type = Regexp.last_match[:v_type]
183
+ {}.tap do |hash|
184
+ value.each do |k, v|
185
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
186
+ end
187
+ end
188
+ else # model
189
+ CMV4APIClient.const_get(type).build_from_hash(value)
190
+ end
191
+ end
192
+
193
+ # Returns the string representation of the object
194
+ # @return [String] String presentation of the object
195
+ def to_s
196
+ to_hash.to_s
197
+ end
198
+
199
+ # to_body is an alias to to_hash (backward compatibility)
200
+ # @return [Hash] Returns the object in the form of hash
201
+ def to_body
202
+ to_hash
203
+ end
204
+
205
+ # Returns the object in the form of hash
206
+ # @return [Hash] Returns the object in the form of hash
207
+ def to_hash
208
+ hash = {}
209
+ self.class.attribute_map.each_pair do |attr, param|
210
+ value = self.send(attr)
211
+ if value.nil?
212
+ is_nullable = self.class.openapi_nullable.include?(attr)
213
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
214
+ end
215
+
216
+ hash[param] = _to_hash(value)
217
+ end
218
+ hash
219
+ end
220
+
221
+ # Outputs non-array value in the form of hash
222
+ # For object, use to_hash. Otherwise, just return the value
223
+ # @param [Object] value Any valid value
224
+ # @return [Hash] Returns the value in the form of hash
225
+ def _to_hash(value)
226
+ if value.is_a?(Array)
227
+ value.compact.map { |v| _to_hash(v) }
228
+ elsif value.is_a?(Hash)
229
+ {}.tap do |hash|
230
+ value.each { |k, v| hash[k] = _to_hash(v) }
231
+ end
232
+ elsif value.respond_to? :to_hash
233
+ value.to_hash
234
+ else
235
+ value
236
+ end
237
+ end
238
+ end
239
+ end
@@ -0,0 +1,308 @@
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 'date'
14
+
15
+ module CMV4APIClient
16
+ class IKnowledgeBaseFieldDefinition
17
+ attr_accessor :id
18
+
19
+ attr_accessor :aggregate_parent
20
+
21
+ attr_accessor :_alias
22
+
23
+ attr_accessor :configuration
24
+
25
+ attr_accessor :field_nature
26
+
27
+ attr_accessor :name
28
+
29
+ attr_accessor :read_only
30
+
31
+ attr_accessor :schema_name
32
+
33
+ attr_accessor :security
34
+
35
+ attr_accessor :type
36
+
37
+ attr_accessor :validators
38
+
39
+ # Attribute mapping from ruby-style variable name to JSON key.
40
+ def self.attribute_map
41
+ {
42
+ :'id' => :'id',
43
+ :'aggregate_parent' => :'aggregateParent',
44
+ :'_alias' => :'alias',
45
+ :'configuration' => :'configuration',
46
+ :'field_nature' => :'fieldNature',
47
+ :'name' => :'name',
48
+ :'read_only' => :'readOnly',
49
+ :'schema_name' => :'schemaName',
50
+ :'security' => :'security',
51
+ :'type' => :'type',
52
+ :'validators' => :'validators'
53
+ }
54
+ end
55
+
56
+ # Attribute type mapping.
57
+ def self.openapi_types
58
+ {
59
+ :'id' => :'String',
60
+ :'aggregate_parent' => :'String',
61
+ :'_alias' => :'String',
62
+ :'configuration' => :'object',
63
+ :'field_nature' => :'FieldNature',
64
+ :'name' => :'String',
65
+ :'read_only' => :'Boolean',
66
+ :'schema_name' => :'String',
67
+ :'security' => :'Array<FieldSecurity>',
68
+ :'type' => :'FieldType',
69
+ :'validators' => :'Array<ValidatorDefinition>'
70
+ }
71
+ end
72
+
73
+ # List of attributes with nullable: true
74
+ def self.openapi_nullable
75
+ Set.new([
76
+ :'id',
77
+ :'aggregate_parent',
78
+ :'_alias',
79
+ :'configuration',
80
+ :'name',
81
+ :'schema_name',
82
+ :'security',
83
+ :'validators'
84
+ ])
85
+ end
86
+
87
+ # Initializes the object
88
+ # @param [Hash] attributes Model attributes in the form of hash
89
+ def initialize(attributes = {})
90
+ if (!attributes.is_a?(Hash))
91
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CMV4APIClient::IKnowledgeBaseFieldDefinition` initialize method"
92
+ end
93
+
94
+ # check to see if the attribute exists and convert string to symbol for hash key
95
+ attributes = attributes.each_with_object({}) { |(k, v), h|
96
+ if (!self.class.attribute_map.key?(k.to_sym))
97
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CMV4APIClient::IKnowledgeBaseFieldDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
98
+ end
99
+ h[k.to_sym] = v
100
+ }
101
+
102
+ if attributes.key?(:'id')
103
+ self.id = attributes[:'id']
104
+ end
105
+
106
+ if attributes.key?(:'aggregate_parent')
107
+ self.aggregate_parent = attributes[:'aggregate_parent']
108
+ end
109
+
110
+ if attributes.key?(:'_alias')
111
+ self._alias = attributes[:'_alias']
112
+ end
113
+
114
+ if attributes.key?(:'configuration')
115
+ self.configuration = attributes[:'configuration']
116
+ end
117
+
118
+ if attributes.key?(:'field_nature')
119
+ self.field_nature = attributes[:'field_nature']
120
+ end
121
+
122
+ if attributes.key?(:'name')
123
+ self.name = attributes[:'name']
124
+ end
125
+
126
+ if attributes.key?(:'read_only')
127
+ self.read_only = attributes[:'read_only']
128
+ end
129
+
130
+ if attributes.key?(:'schema_name')
131
+ self.schema_name = attributes[:'schema_name']
132
+ end
133
+
134
+ if attributes.key?(:'security')
135
+ if (value = attributes[:'security']).is_a?(Array)
136
+ self.security = value
137
+ end
138
+ end
139
+
140
+ if attributes.key?(:'type')
141
+ self.type = attributes[:'type']
142
+ end
143
+
144
+ if attributes.key?(:'validators')
145
+ if (value = attributes[:'validators']).is_a?(Array)
146
+ self.validators = value
147
+ end
148
+ end
149
+ end
150
+
151
+ # Show invalid properties with the reasons. Usually used together with valid?
152
+ # @return Array for valid properties with the reasons
153
+ def list_invalid_properties
154
+ invalid_properties = Array.new
155
+ invalid_properties
156
+ end
157
+
158
+ # Check to see if the all the properties in the model are valid
159
+ # @return true if the model is valid
160
+ def valid?
161
+ true
162
+ end
163
+
164
+ # Checks equality by comparing each attribute.
165
+ # @param [Object] Object to be compared
166
+ def ==(o)
167
+ return true if self.equal?(o)
168
+ self.class == o.class &&
169
+ id == o.id &&
170
+ aggregate_parent == o.aggregate_parent &&
171
+ _alias == o._alias &&
172
+ configuration == o.configuration &&
173
+ field_nature == o.field_nature &&
174
+ name == o.name &&
175
+ read_only == o.read_only &&
176
+ schema_name == o.schema_name &&
177
+ security == o.security &&
178
+ type == o.type &&
179
+ validators == o.validators
180
+ end
181
+
182
+ # @see the `==` method
183
+ # @param [Object] Object to be compared
184
+ def eql?(o)
185
+ self == o
186
+ end
187
+
188
+ # Calculates hash code according to all attributes.
189
+ # @return [Integer] Hash code
190
+ def hash
191
+ [id, aggregate_parent, _alias, configuration, field_nature, name, read_only, schema_name, security, type, validators].hash
192
+ end
193
+
194
+ # Builds the object from hash
195
+ # @param [Hash] attributes Model attributes in the form of hash
196
+ # @return [Object] Returns the model itself
197
+ def self.build_from_hash(attributes)
198
+ new.build_from_hash(attributes)
199
+ end
200
+
201
+ # Builds the object from hash
202
+ # @param [Hash] attributes Model attributes in the form of hash
203
+ # @return [Object] Returns the model itself
204
+ def build_from_hash(attributes)
205
+ return nil unless attributes.is_a?(Hash)
206
+ self.class.openapi_types.each_pair do |key, type|
207
+ if type =~ /\AArray<(.*)>/i
208
+ # check to ensure the input is an array given that the attribute
209
+ # is documented as an array but the input is not
210
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
211
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
212
+ end
213
+ elsif !attributes[self.class.attribute_map[key]].nil?
214
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
215
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
216
+ end
217
+
218
+ self
219
+ end
220
+
221
+ # Deserializes the data based on type
222
+ # @param string type Data type
223
+ # @param string value Value to be deserialized
224
+ # @return [Object] Deserialized data
225
+ def _deserialize(type, value)
226
+ case type.to_sym
227
+ when :DateTime
228
+ DateTime.parse(value)
229
+ when :Date
230
+ Date.parse(value)
231
+ when :String
232
+ value.to_s
233
+ when :Integer
234
+ value.to_i
235
+ when :Float
236
+ value.to_f
237
+ when :Boolean
238
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
239
+ true
240
+ else
241
+ false
242
+ end
243
+ when :object
244
+ # generic object (usually a Hash), return directly
245
+ value
246
+ when /\AArray<(?<inner_type>.+)>\z/
247
+ inner_type = Regexp.last_match[:inner_type]
248
+ value.map { |v| _deserialize(inner_type, v) }
249
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
250
+ k_type = Regexp.last_match[:k_type]
251
+ v_type = Regexp.last_match[:v_type]
252
+ {}.tap do |hash|
253
+ value.each do |k, v|
254
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
255
+ end
256
+ end
257
+ else # model
258
+ CMV4APIClient.const_get(type).build_from_hash(value)
259
+ end
260
+ end
261
+
262
+ # Returns the string representation of the object
263
+ # @return [String] String presentation of the object
264
+ def to_s
265
+ to_hash.to_s
266
+ end
267
+
268
+ # to_body is an alias to to_hash (backward compatibility)
269
+ # @return [Hash] Returns the object in the form of hash
270
+ def to_body
271
+ to_hash
272
+ end
273
+
274
+ # Returns the object in the form of hash
275
+ # @return [Hash] Returns the object in the form of hash
276
+ def to_hash
277
+ hash = {}
278
+ self.class.attribute_map.each_pair do |attr, param|
279
+ value = self.send(attr)
280
+ if value.nil?
281
+ is_nullable = self.class.openapi_nullable.include?(attr)
282
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
283
+ end
284
+
285
+ hash[param] = _to_hash(value)
286
+ end
287
+ hash
288
+ end
289
+
290
+ # Outputs non-array value in the form of hash
291
+ # For object, use to_hash. Otherwise, just return the value
292
+ # @param [Object] value Any valid value
293
+ # @return [Hash] Returns the value in the form of hash
294
+ def _to_hash(value)
295
+ if value.is_a?(Array)
296
+ value.compact.map { |v| _to_hash(v) }
297
+ elsif value.is_a?(Hash)
298
+ {}.tap do |hash|
299
+ value.each { |k, v| hash[k] = _to_hash(v) }
300
+ end
301
+ elsif value.respond_to? :to_hash
302
+ value.to_hash
303
+ else
304
+ value
305
+ end
306
+ end
307
+ end
308
+ end