ionoscloud 6.0.0.beta.4 → 6.0.0

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 (561) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -2
  3. data/docs/README.md +64 -0
  4. data/docs/api/BackupUnitsApi.md +61 -61
  5. data/docs/api/ContractResourcesApi.md +6 -6
  6. data/docs/api/DataCentersApi.md +13 -13
  7. data/docs/api/DefaultApi.md +1 -1
  8. data/docs/api/FirewallRulesApi.md +73 -73
  9. data/docs/api/FlowLogsApi.md +69 -69
  10. data/docs/api/IPBlocksApi.md +51 -51
  11. data/docs/api/ImagesApi.md +41 -41
  12. data/docs/api/KubernetesApi.md +153 -153
  13. data/docs/api/{LansApi.md → LANsApi.md} +105 -105
  14. data/docs/api/LabelsApi.md +259 -259
  15. data/docs/api/LoadBalancersApi.md +82 -82
  16. data/docs/api/LocationsApi.md +11 -11
  17. data/docs/api/NATGatewaysApi.md +163 -163
  18. data/docs/api/NetworkInterfacesApi.md +61 -61
  19. data/docs/api/NetworkLoadBalancersApi.md +167 -167
  20. data/docs/api/PrivateCrossConnectsApi.md +39 -39
  21. data/docs/api/RequestsApi.md +44 -44
  22. data/docs/api/ServersApi.md +179 -179
  23. data/docs/api/SnapshotsApi.md +40 -40
  24. data/docs/api/TemplatesApi.md +14 -14
  25. data/docs/api/UserManagementApi.md +207 -205
  26. data/docs/api/UserS3KeysApi.md +55 -55
  27. data/docs/api/VolumesApi.md +74 -74
  28. data/docs/models/AttachedVolumes.md +6 -6
  29. data/docs/models/BackupUnit.md +3 -3
  30. data/docs/models/BackupUnitProperties.md +2 -2
  31. data/docs/models/BackupUnits.md +4 -4
  32. data/docs/models/BalancedNics.md +6 -6
  33. data/docs/models/Cdroms.md +6 -6
  34. data/docs/models/Contract.md +1 -1
  35. data/docs/models/ContractProperties.md +4 -4
  36. data/docs/models/Contracts.md +3 -3
  37. data/docs/models/CpuArchitectureProperties.md +1 -1
  38. data/docs/models/Datacenter.md +3 -3
  39. data/docs/models/DatacenterElementMetadata.md +6 -6
  40. data/docs/models/DatacenterProperties.md +6 -6
  41. data/docs/models/Datacenters.md +6 -6
  42. data/docs/models/Error.md +1 -1
  43. data/docs/models/ErrorMessage.md +3 -3
  44. data/docs/models/FirewallRule.md +3 -3
  45. data/docs/models/FirewallRules.md +6 -6
  46. data/docs/models/FirewallruleProperties.md +10 -10
  47. data/docs/models/FlowLog.md +3 -3
  48. data/docs/models/FlowLogProperties.md +1 -1
  49. data/docs/models/FlowLogPut.md +3 -3
  50. data/docs/models/FlowLogs.md +6 -6
  51. data/docs/models/Group.md +3 -3
  52. data/docs/models/GroupMembers.md +4 -4
  53. data/docs/models/GroupProperties.md +11 -11
  54. data/docs/models/GroupShare.md +2 -2
  55. data/docs/models/GroupShares.md +3 -3
  56. data/docs/models/GroupUsers.md +4 -4
  57. data/docs/models/Groups.md +4 -4
  58. data/docs/models/Image.md +3 -3
  59. data/docs/models/ImageProperties.md +17 -17
  60. data/docs/models/Images.md +4 -4
  61. data/docs/models/IpBlock.md +3 -3
  62. data/docs/models/IpBlockProperties.md +5 -5
  63. data/docs/models/IpBlocks.md +5 -5
  64. data/docs/models/KubernetesCluster.md +2 -2
  65. data/docs/models/KubernetesClusterForPost.md +2 -2
  66. data/docs/models/KubernetesClusterForPut.md +2 -2
  67. data/docs/models/KubernetesClusterProperties.md +3 -5
  68. data/docs/models/KubernetesClusterPropertiesForPost.md +3 -5
  69. data/docs/models/KubernetesClusterPropertiesForPut.md +3 -3
  70. data/docs/models/KubernetesClusters.md +4 -4
  71. data/docs/models/KubernetesNode.md +2 -2
  72. data/docs/models/KubernetesNodeMetadata.md +4 -4
  73. data/docs/models/KubernetesNodePool.md +2 -2
  74. data/docs/models/KubernetesNodePoolForPost.md +2 -2
  75. data/docs/models/KubernetesNodePoolForPut.md +2 -2
  76. data/docs/models/KubernetesNodePoolLan.md +1 -1
  77. data/docs/models/KubernetesNodePoolProperties.md +12 -15
  78. data/docs/models/KubernetesNodePoolPropertiesForPost.md +11 -14
  79. data/docs/models/KubernetesNodePoolPropertiesForPut.md +5 -5
  80. data/docs/models/KubernetesNodePools.md +4 -4
  81. data/docs/models/KubernetesNodeProperties.md +2 -2
  82. data/docs/models/KubernetesNodes.md +4 -4
  83. data/docs/models/Label.md +2 -2
  84. data/docs/models/LabelProperties.md +3 -3
  85. data/docs/models/LabelResource.md +2 -2
  86. data/docs/models/LabelResourceProperties.md +2 -2
  87. data/docs/models/LabelResources.md +6 -6
  88. data/docs/models/Labels.md +4 -4
  89. data/docs/models/Lan.md +3 -3
  90. data/docs/models/LanNics.md +6 -6
  91. data/docs/models/LanPost.md +3 -3
  92. data/docs/models/LanProperties.md +3 -3
  93. data/docs/models/LanPropertiesPost.md +3 -3
  94. data/docs/models/Lans.md +6 -6
  95. data/docs/models/Loadbalancer.md +3 -3
  96. data/docs/models/LoadbalancerProperties.md +3 -3
  97. data/docs/models/Loadbalancers.md +6 -6
  98. data/docs/models/Location.md +3 -3
  99. data/docs/models/LocationProperties.md +1 -1
  100. data/docs/models/Locations.md +4 -4
  101. data/docs/models/NatGateway.md +3 -3
  102. data/docs/models/NatGatewayLanProperties.md +2 -2
  103. data/docs/models/NatGatewayProperties.md +3 -3
  104. data/docs/models/NatGatewayPut.md +3 -3
  105. data/docs/models/NatGatewayRule.md +3 -3
  106. data/docs/models/NatGatewayRuleProperties.md +7 -7
  107. data/docs/models/NatGatewayRulePut.md +3 -3
  108. data/docs/models/NatGatewayRules.md +4 -4
  109. data/docs/models/NatGateways.md +6 -6
  110. data/docs/models/NetworkLoadBalancer.md +3 -3
  111. data/docs/models/NetworkLoadBalancerForwardingRule.md +3 -3
  112. data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +2 -2
  113. data/docs/models/NetworkLoadBalancerForwardingRulePut.md +3 -3
  114. data/docs/models/NetworkLoadBalancerForwardingRules.md +6 -6
  115. data/docs/models/NetworkLoadBalancerProperties.md +4 -4
  116. data/docs/models/NetworkLoadBalancerPut.md +3 -3
  117. data/docs/models/NetworkLoadBalancers.md +6 -6
  118. data/docs/models/Nic.md +3 -3
  119. data/docs/models/NicProperties.md +8 -8
  120. data/docs/models/NicPut.md +3 -3
  121. data/docs/models/Nics.md +6 -6
  122. data/docs/models/NoStateMetaData.md +5 -5
  123. data/docs/models/PaginationLinks.md +3 -3
  124. data/docs/models/PrivateCrossConnect.md +3 -3
  125. data/docs/models/PrivateCrossConnectProperties.md +4 -4
  126. data/docs/models/PrivateCrossConnects.md +4 -4
  127. data/docs/models/Request.md +3 -3
  128. data/docs/models/RequestMetadata.md +2 -2
  129. data/docs/models/RequestStatus.md +3 -3
  130. data/docs/models/RequestStatusMetadata.md +1 -1
  131. data/docs/models/Requests.md +6 -6
  132. data/docs/models/Resource.md +3 -3
  133. data/docs/models/ResourceGroups.md +4 -4
  134. data/docs/models/ResourceLimits.md +22 -22
  135. data/docs/models/ResourceProperties.md +2 -2
  136. data/docs/models/ResourceReference.md +3 -3
  137. data/docs/models/Resources.md +4 -4
  138. data/docs/models/ResourcesUsers.md +4 -4
  139. data/docs/models/S3Key.md +3 -3
  140. data/docs/models/S3KeyMetadata.md +2 -2
  141. data/docs/models/S3KeyProperties.md +2 -2
  142. data/docs/models/S3Keys.md +4 -4
  143. data/docs/models/Server.md +3 -3
  144. data/docs/models/ServerProperties.md +7 -7
  145. data/docs/models/Servers.md +6 -6
  146. data/docs/models/Snapshot.md +3 -3
  147. data/docs/models/SnapshotProperties.md +14 -14
  148. data/docs/models/Snapshots.md +4 -4
  149. data/docs/models/TargetPortRange.md +2 -2
  150. data/docs/models/Template.md +3 -3
  151. data/docs/models/TemplateProperties.md +4 -4
  152. data/docs/models/Templates.md +4 -4
  153. data/docs/models/Token.md +1 -1
  154. data/docs/models/User.md +3 -3
  155. data/docs/models/UserMetadata.md +3 -3
  156. data/docs/models/UserProperties.md +8 -8
  157. data/docs/models/UserPropertiesPost.md +8 -8
  158. data/docs/models/UserPropertiesPut.md +9 -7
  159. data/docs/models/UserPut.md +1 -1
  160. data/docs/models/Users.md +6 -6
  161. data/docs/models/Volume.md +3 -3
  162. data/docs/models/VolumeProperties.md +17 -17
  163. data/docs/models/Volumes.md +6 -6
  164. data/docs/summary.md +192 -382
  165. data/ionoscloud.gemspec +1 -1
  166. data/lib/ionoscloud/api/_api.rb +1 -1
  167. data/lib/ionoscloud/api/backup_units_api.rb +52 -52
  168. data/lib/ionoscloud/api/contract_resources_api.rb +5 -5
  169. data/lib/ionoscloud/api/data_centers_api.rb +13 -13
  170. data/lib/ionoscloud/api/firewall_rules_api.rb +63 -63
  171. data/lib/ionoscloud/api/flow_logs_api.rb +61 -61
  172. data/lib/ionoscloud/api/images_api.rb +33 -33
  173. data/lib/ionoscloud/api/ip_blocks_api.rb +41 -41
  174. data/lib/ionoscloud/api/kubernetes_api.rb +130 -130
  175. data/lib/ionoscloud/api/labels_api.rb +211 -211
  176. data/lib/ionoscloud/api/lans_api.rb +134 -134
  177. data/lib/ionoscloud/api/load_balancers_api.rb +67 -67
  178. data/lib/ionoscloud/api/locations_api.rb +11 -11
  179. data/lib/ionoscloud/api/nat_gateways_api.rb +135 -135
  180. data/lib/ionoscloud/api/network_interfaces_api.rb +51 -51
  181. data/lib/ionoscloud/api/network_load_balancers_api.rb +137 -137
  182. data/lib/ionoscloud/api/private_cross_connects_api.rb +31 -31
  183. data/lib/ionoscloud/api/requests_api.rb +39 -39
  184. data/lib/ionoscloud/api/servers_api.rb +147 -147
  185. data/lib/ionoscloud/api/snapshots_api.rb +31 -31
  186. data/lib/ionoscloud/api/templates_api.rb +11 -11
  187. data/lib/ionoscloud/api/user_management_api.rb +163 -161
  188. data/lib/ionoscloud/api/user_s3_keys_api.rb +45 -45
  189. data/lib/ionoscloud/api/volumes_api.rb +61 -61
  190. data/lib/ionoscloud/api_client.rb +2 -2
  191. data/lib/ionoscloud/api_error.rb +1 -1
  192. data/lib/ionoscloud/configuration.rb +1 -1
  193. data/lib/ionoscloud/models/attached_volumes.rb +72 -18
  194. data/lib/ionoscloud/models/backup_unit.rb +49 -9
  195. data/lib/ionoscloud/models/backup_unit_properties.rb +30 -6
  196. data/lib/ionoscloud/models/backup_unit_sso.rb +10 -2
  197. data/lib/ionoscloud/models/backup_units.rb +43 -13
  198. data/lib/ionoscloud/models/balanced_nics.rb +72 -18
  199. data/lib/ionoscloud/models/cdroms.rb +72 -18
  200. data/lib/ionoscloud/models/connectable_datacenter.rb +28 -4
  201. data/lib/ionoscloud/models/contract.rb +20 -4
  202. data/lib/ionoscloud/models/contract_properties.rb +50 -10
  203. data/lib/ionoscloud/models/contracts.rb +42 -12
  204. data/lib/ionoscloud/models/cpu_architecture_properties.rb +38 -6
  205. data/lib/ionoscloud/models/data_center_entities.rb +55 -7
  206. data/lib/ionoscloud/models/datacenter.rb +58 -10
  207. data/lib/ionoscloud/models/datacenter_element_metadata.rb +79 -15
  208. data/lib/ionoscloud/models/datacenter_properties.rb +74 -22
  209. data/lib/ionoscloud/models/datacenters.rb +72 -18
  210. data/lib/ionoscloud/models/error.rb +22 -8
  211. data/lib/ionoscloud/models/error_message.rb +21 -5
  212. data/lib/ionoscloud/models/firewall_rule.rb +49 -9
  213. data/lib/ionoscloud/models/firewall_rules.rb +72 -18
  214. data/lib/ionoscloud/models/firewallrule_properties.rb +101 -21
  215. data/lib/ionoscloud/models/flow_log.rb +49 -9
  216. data/lib/ionoscloud/models/flow_log_properties.rb +38 -6
  217. data/lib/ionoscloud/models/flow_log_put.rb +40 -8
  218. data/lib/ionoscloud/models/flow_logs.rb +72 -18
  219. data/lib/ionoscloud/models/group.rb +49 -9
  220. data/lib/ionoscloud/models/group_entities.rb +19 -3
  221. data/lib/ionoscloud/models/group_members.rb +43 -13
  222. data/lib/ionoscloud/models/group_properties.rb +129 -25
  223. data/lib/ionoscloud/models/group_share.rb +39 -7
  224. data/lib/ionoscloud/models/group_share_properties.rb +19 -3
  225. data/lib/ionoscloud/models/group_shares.rb +42 -12
  226. data/lib/ionoscloud/models/group_users.rb +44 -14
  227. data/lib/ionoscloud/models/groups.rb +43 -13
  228. data/lib/ionoscloud/models/image.rb +49 -9
  229. data/lib/ionoscloud/models/image_properties.rb +191 -41
  230. data/lib/ionoscloud/models/images.rb +43 -13
  231. data/lib/ionoscloud/models/info.rb +28 -4
  232. data/lib/ionoscloud/models/ip_block.rb +49 -9
  233. data/lib/ionoscloud/models/ip_block_properties.rb +55 -19
  234. data/lib/ionoscloud/models/ip_blocks.rb +71 -17
  235. data/lib/ionoscloud/models/ip_consumer.rb +82 -10
  236. data/lib/ionoscloud/models/ip_failover.rb +19 -3
  237. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +19 -3
  238. data/lib/ionoscloud/models/kubernetes_cluster.rb +57 -9
  239. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +10 -2
  240. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +57 -9
  241. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +57 -9
  242. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +74 -38
  243. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +52 -28
  244. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +53 -17
  245. data/lib/ionoscloud/models/kubernetes_clusters.rb +43 -13
  246. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +19 -3
  247. data/lib/ionoscloud/models/kubernetes_node.rb +48 -8
  248. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +50 -10
  249. data/lib/ionoscloud/models/kubernetes_node_pool.rb +48 -8
  250. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +48 -8
  251. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +48 -8
  252. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +31 -9
  253. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +19 -3
  254. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +176 -60
  255. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +164 -54
  256. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +94 -35
  257. data/lib/ionoscloud/models/kubernetes_node_pools.rb +43 -13
  258. data/lib/ionoscloud/models/kubernetes_node_properties.rb +39 -7
  259. data/lib/ionoscloud/models/kubernetes_nodes.rb +43 -13
  260. data/lib/ionoscloud/models/label.rb +48 -8
  261. data/lib/ionoscloud/models/label_properties.rb +49 -9
  262. data/lib/ionoscloud/models/label_resource.rb +48 -8
  263. data/lib/ionoscloud/models/label_resource_properties.rb +21 -5
  264. data/lib/ionoscloud/models/label_resources.rb +72 -18
  265. data/lib/ionoscloud/models/labels.rb +43 -13
  266. data/lib/ionoscloud/models/lan.rb +58 -10
  267. data/lib/ionoscloud/models/lan_entities.rb +10 -2
  268. data/lib/ionoscloud/models/lan_nics.rb +72 -18
  269. data/lib/ionoscloud/models/lan_post.rb +58 -10
  270. data/lib/ionoscloud/models/lan_properties.rb +42 -12
  271. data/lib/ionoscloud/models/lan_properties_post.rb +42 -12
  272. data/lib/ionoscloud/models/lans.rb +72 -18
  273. data/lib/ionoscloud/models/loadbalancer.rb +58 -10
  274. data/lib/ionoscloud/models/loadbalancer_entities.rb +10 -2
  275. data/lib/ionoscloud/models/loadbalancer_properties.rb +31 -7
  276. data/lib/ionoscloud/models/loadbalancers.rb +72 -18
  277. data/lib/ionoscloud/models/location.rb +49 -9
  278. data/lib/ionoscloud/models/location_properties.rb +44 -18
  279. data/lib/ionoscloud/models/locations.rb +43 -13
  280. data/lib/ionoscloud/models/nat_gateway.rb +58 -10
  281. data/lib/ionoscloud/models/nat_gateway_entities.rb +19 -3
  282. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +23 -9
  283. data/lib/ionoscloud/models/nat_gateway_properties.rb +35 -15
  284. data/lib/ionoscloud/models/nat_gateway_put.rb +40 -8
  285. data/lib/ionoscloud/models/nat_gateway_rule.rb +49 -9
  286. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +70 -14
  287. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +1 -1
  288. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +40 -8
  289. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +1 -1
  290. data/lib/ionoscloud/models/nat_gateway_rules.rb +43 -13
  291. data/lib/ionoscloud/models/nat_gateways.rb +72 -18
  292. data/lib/ionoscloud/models/network_load_balancer.rb +58 -10
  293. data/lib/ionoscloud/models/network_load_balancer_entities.rb +19 -3
  294. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +49 -9
  295. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +37 -5
  296. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +68 -14
  297. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +40 -8
  298. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +37 -5
  299. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +28 -4
  300. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +72 -18
  301. data/lib/ionoscloud/models/network_load_balancer_properties.rb +54 -18
  302. data/lib/ionoscloud/models/network_load_balancer_put.rb +40 -8
  303. data/lib/ionoscloud/models/network_load_balancers.rb +72 -18
  304. data/lib/ionoscloud/models/nic.rb +58 -10
  305. data/lib/ionoscloud/models/nic_entities.rb +19 -3
  306. data/lib/ionoscloud/models/nic_properties.rb +92 -22
  307. data/lib/ionoscloud/models/nic_put.rb +40 -8
  308. data/lib/ionoscloud/models/nics.rb +72 -18
  309. data/lib/ionoscloud/models/no_state_meta_data.rb +69 -13
  310. data/lib/ionoscloud/models/pagination_links.rb +31 -7
  311. data/lib/ionoscloud/models/peer.rb +46 -6
  312. data/lib/ionoscloud/models/private_cross_connect.rb +49 -9
  313. data/lib/ionoscloud/models/private_cross_connect_properties.rb +45 -17
  314. data/lib/ionoscloud/models/private_cross_connects.rb +43 -13
  315. data/lib/ionoscloud/models/remote_console_url.rb +10 -2
  316. data/lib/ionoscloud/models/request.rb +49 -9
  317. data/lib/ionoscloud/models/request_metadata.rb +39 -7
  318. data/lib/ionoscloud/models/request_properties.rb +39 -9
  319. data/lib/ionoscloud/models/request_status.rb +40 -8
  320. data/lib/ionoscloud/models/request_status_metadata.rb +40 -10
  321. data/lib/ionoscloud/models/request_target.rb +19 -3
  322. data/lib/ionoscloud/models/requests.rb +72 -18
  323. data/lib/ionoscloud/models/resource.rb +58 -10
  324. data/lib/ionoscloud/models/resource_entities.rb +10 -2
  325. data/lib/ionoscloud/models/resource_groups.rb +43 -13
  326. data/lib/ionoscloud/models/resource_limits.rb +221 -45
  327. data/lib/ionoscloud/models/resource_properties.rb +21 -5
  328. data/lib/ionoscloud/models/resource_reference.rb +31 -7
  329. data/lib/ionoscloud/models/resources.rb +44 -14
  330. data/lib/ionoscloud/models/resources_users.rb +43 -13
  331. data/lib/ionoscloud/models/s3_bucket.rb +10 -2
  332. data/lib/ionoscloud/models/s3_key.rb +49 -9
  333. data/lib/ionoscloud/models/s3_key_metadata.rb +21 -5
  334. data/lib/ionoscloud/models/s3_key_properties.rb +21 -5
  335. data/lib/ionoscloud/models/s3_keys.rb +43 -13
  336. data/lib/ionoscloud/models/s3_object_storage_sso.rb +10 -2
  337. data/lib/ionoscloud/models/server.rb +58 -10
  338. data/lib/ionoscloud/models/server_entities.rb +28 -4
  339. data/lib/ionoscloud/models/server_properties.rb +98 -18
  340. data/lib/ionoscloud/models/servers.rb +72 -18
  341. data/lib/ionoscloud/models/snapshot.rb +49 -9
  342. data/lib/ionoscloud/models/snapshot_properties.rb +159 -31
  343. data/lib/ionoscloud/models/snapshots.rb +43 -13
  344. data/lib/ionoscloud/models/target_port_range.rb +21 -5
  345. data/lib/ionoscloud/models/template.rb +49 -9
  346. data/lib/ionoscloud/models/template_properties.rb +41 -9
  347. data/lib/ionoscloud/models/templates.rb +43 -13
  348. data/lib/ionoscloud/models/token.rb +11 -3
  349. data/lib/ionoscloud/models/type.rb +1 -1
  350. data/lib/ionoscloud/models/user.rb +58 -10
  351. data/lib/ionoscloud/models/user_metadata.rb +31 -7
  352. data/lib/ionoscloud/models/user_post.rb +10 -2
  353. data/lib/ionoscloud/models/user_properties.rb +81 -17
  354. data/lib/ionoscloud/models/user_properties_post.rb +81 -17
  355. data/lib/ionoscloud/models/user_properties_put.rb +90 -16
  356. data/lib/ionoscloud/models/user_put.rb +20 -4
  357. data/lib/ionoscloud/models/users.rb +72 -18
  358. data/lib/ionoscloud/models/users_entities.rb +19 -3
  359. data/lib/ionoscloud/models/volume.rb +49 -9
  360. data/lib/ionoscloud/models/volume_properties.rb +200 -42
  361. data/lib/ionoscloud/models/volumes.rb +72 -18
  362. data/lib/ionoscloud/version.rb +2 -2
  363. data/lib/ionoscloud.rb +2 -2
  364. data/sonar-project.properties +12 -0
  365. data/spec/api_client_spec.rb +1 -1
  366. data/spec/configuration_spec.rb +1 -1
  367. data/spec/spec_helper.rb +1 -1
  368. metadata +6 -391
  369. data/spec/api/_api_spec.rb +0 -49
  370. data/spec/api/backup_units_api_spec.rb +0 -140
  371. data/spec/api/contract_resources_api_spec.rb +0 -49
  372. data/spec/api/data_centers_api_spec.rb +0 -128
  373. data/spec/api/firewall_rules_api_spec.rb +0 -146
  374. data/spec/api/flow_logs_api_spec.rb +0 -140
  375. data/spec/api/images_api_spec.rb +0 -111
  376. data/spec/api/ip_blocks_api_spec.rb +0 -128
  377. data/spec/api/kubernetes_api_spec.rb +0 -294
  378. data/spec/api/labels_api_spec.rb +0 -474
  379. data/spec/api/lans_api_spec.rb +0 -186
  380. data/spec/api/load_balancers_api_spec.rb +0 -201
  381. data/spec/api/locations_api_spec.rb +0 -80
  382. data/spec/api/nat_gateways_api_spec.rb +0 -334
  383. data/spec/api/network_interfaces_api_spec.rb +0 -140
  384. data/spec/api/network_load_balancers_api_spec.rb +0 -340
  385. data/spec/api/private_cross_connects_api_spec.rb +0 -110
  386. data/spec/api/requests_api_spec.rb +0 -92
  387. data/spec/api/servers_api_spec.rb +0 -401
  388. data/spec/api/snapshots_api_spec.rb +0 -111
  389. data/spec/api/templates_api_spec.rb +0 -60
  390. data/spec/api/user_management_api_spec.rb +0 -404
  391. data/spec/api/user_s3_keys_api_spec.rb +0 -128
  392. data/spec/api/volumes_api_spec.rb +0 -171
  393. data/spec/models/attached_volumes_spec.rb +0 -70
  394. data/spec/models/backup_unit_properties_spec.rb +0 -46
  395. data/spec/models/backup_unit_spec.rb +0 -62
  396. data/spec/models/backup_unit_sso_spec.rb +0 -34
  397. data/spec/models/backup_units_spec.rb +0 -56
  398. data/spec/models/balanced_nics_spec.rb +0 -70
  399. data/spec/models/cdroms_spec.rb +0 -70
  400. data/spec/models/connectable_datacenter_spec.rb +0 -46
  401. data/spec/models/contract_properties_spec.rb +0 -58
  402. data/spec/models/contract_spec.rb +0 -40
  403. data/spec/models/contracts_spec.rb +0 -52
  404. data/spec/models/cpu_architecture_properties_spec.rb +0 -52
  405. data/spec/models/data_center_entities_spec.rb +0 -64
  406. data/spec/models/datacenter_element_metadata_spec.rb +0 -80
  407. data/spec/models/datacenter_properties_spec.rb +0 -70
  408. data/spec/models/datacenter_spec.rb +0 -64
  409. data/spec/models/datacenters_spec.rb +0 -70
  410. data/spec/models/error_message_spec.rb +0 -40
  411. data/spec/models/error_spec.rb +0 -40
  412. data/spec/models/firewall_rule_spec.rb +0 -58
  413. data/spec/models/firewall_rules_spec.rb +0 -70
  414. data/spec/models/firewallrule_properties_spec.rb +0 -96
  415. data/spec/models/flow_log_properties_spec.rb +0 -60
  416. data/spec/models/flow_log_put_spec.rb +0 -52
  417. data/spec/models/flow_log_spec.rb +0 -58
  418. data/spec/models/flow_logs_spec.rb +0 -70
  419. data/spec/models/group_entities_spec.rb +0 -40
  420. data/spec/models/group_members_spec.rb +0 -52
  421. data/spec/models/group_properties_spec.rb +0 -106
  422. data/spec/models/group_share_properties_spec.rb +0 -40
  423. data/spec/models/group_share_spec.rb +0 -52
  424. data/spec/models/group_shares_spec.rb +0 -52
  425. data/spec/models/group_spec.rb +0 -58
  426. data/spec/models/group_users_spec.rb +0 -52
  427. data/spec/models/groups_spec.rb +0 -52
  428. data/spec/models/image_properties_spec.rb +0 -154
  429. data/spec/models/image_spec.rb +0 -58
  430. data/spec/models/images_spec.rb +0 -52
  431. data/spec/models/info_spec.rb +0 -46
  432. data/spec/models/ip_block_properties_spec.rb +0 -58
  433. data/spec/models/ip_block_spec.rb +0 -58
  434. data/spec/models/ip_blocks_spec.rb +0 -70
  435. data/spec/models/ip_consumer_spec.rb +0 -82
  436. data/spec/models/ip_failover_spec.rb +0 -40
  437. data/spec/models/kubernetes_auto_scaling_spec.rb +0 -40
  438. data/spec/models/kubernetes_cluster_entities_spec.rb +0 -34
  439. data/spec/models/kubernetes_cluster_for_post_spec.rb +0 -68
  440. data/spec/models/kubernetes_cluster_for_put_spec.rb +0 -68
  441. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +0 -64
  442. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +0 -58
  443. data/spec/models/kubernetes_cluster_properties_spec.rb +0 -76
  444. data/spec/models/kubernetes_cluster_spec.rb +0 -68
  445. data/spec/models/kubernetes_clusters_spec.rb +0 -56
  446. data/spec/models/kubernetes_maintenance_window_spec.rb +0 -44
  447. data/spec/models/kubernetes_node_metadata_spec.rb +0 -62
  448. data/spec/models/kubernetes_node_pool_for_post_spec.rb +0 -62
  449. data/spec/models/kubernetes_node_pool_for_put_spec.rb +0 -62
  450. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +0 -40
  451. data/spec/models/kubernetes_node_pool_lan_spec.rb +0 -46
  452. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +0 -138
  453. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -82
  454. data/spec/models/kubernetes_node_pool_properties_spec.rb +0 -144
  455. data/spec/models/kubernetes_node_pool_spec.rb +0 -62
  456. data/spec/models/kubernetes_node_pools_spec.rb +0 -56
  457. data/spec/models/kubernetes_node_properties_spec.rb +0 -52
  458. data/spec/models/kubernetes_node_spec.rb +0 -62
  459. data/spec/models/kubernetes_nodes_spec.rb +0 -56
  460. data/spec/models/label_properties_spec.rb +0 -58
  461. data/spec/models/label_resource_properties_spec.rb +0 -40
  462. data/spec/models/label_resource_spec.rb +0 -62
  463. data/spec/models/label_resources_spec.rb +0 -74
  464. data/spec/models/label_spec.rb +0 -62
  465. data/spec/models/labels_spec.rb +0 -56
  466. data/spec/models/lan_entities_spec.rb +0 -34
  467. data/spec/models/lan_nics_spec.rb +0 -70
  468. data/spec/models/lan_post_spec.rb +0 -64
  469. data/spec/models/lan_properties_post_spec.rb +0 -52
  470. data/spec/models/lan_properties_spec.rb +0 -52
  471. data/spec/models/lan_spec.rb +0 -64
  472. data/spec/models/lans_spec.rb +0 -70
  473. data/spec/models/loadbalancer_entities_spec.rb +0 -34
  474. data/spec/models/loadbalancer_properties_spec.rb +0 -46
  475. data/spec/models/loadbalancer_spec.rb +0 -64
  476. data/spec/models/loadbalancers_spec.rb +0 -70
  477. data/spec/models/location_properties_spec.rb +0 -52
  478. data/spec/models/location_spec.rb +0 -58
  479. data/spec/models/locations_spec.rb +0 -52
  480. data/spec/models/nat_gateway_entities_spec.rb +0 -40
  481. data/spec/models/nat_gateway_lan_properties_spec.rb +0 -40
  482. data/spec/models/nat_gateway_properties_spec.rb +0 -46
  483. data/spec/models/nat_gateway_put_spec.rb +0 -52
  484. data/spec/models/nat_gateway_rule_properties_spec.rb +0 -70
  485. data/spec/models/nat_gateway_rule_protocol_spec.rb +0 -28
  486. data/spec/models/nat_gateway_rule_put_spec.rb +0 -52
  487. data/spec/models/nat_gateway_rule_spec.rb +0 -58
  488. data/spec/models/nat_gateway_rule_type_spec.rb +0 -28
  489. data/spec/models/nat_gateway_rules_spec.rb +0 -52
  490. data/spec/models/nat_gateway_spec.rb +0 -64
  491. data/spec/models/nat_gateways_spec.rb +0 -70
  492. data/spec/models/network_load_balancer_entities_spec.rb +0 -40
  493. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +0 -52
  494. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +0 -78
  495. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +0 -52
  496. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +0 -58
  497. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +0 -46
  498. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +0 -52
  499. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +0 -70
  500. data/spec/models/network_load_balancer_properties_spec.rb +0 -58
  501. data/spec/models/network_load_balancer_put_spec.rb +0 -52
  502. data/spec/models/network_load_balancer_spec.rb +0 -64
  503. data/spec/models/network_load_balancers_spec.rb +0 -70
  504. data/spec/models/nic_entities_spec.rb +0 -40
  505. data/spec/models/nic_properties_spec.rb +0 -86
  506. data/spec/models/nic_put_spec.rb +0 -52
  507. data/spec/models/nic_spec.rb +0 -64
  508. data/spec/models/nics_spec.rb +0 -70
  509. data/spec/models/no_state_meta_data_spec.rb +0 -70
  510. data/spec/models/pagination_links_spec.rb +0 -46
  511. data/spec/models/peer_spec.rb +0 -58
  512. data/spec/models/private_cross_connect_properties_spec.rb +0 -52
  513. data/spec/models/private_cross_connect_spec.rb +0 -58
  514. data/spec/models/private_cross_connects_spec.rb +0 -52
  515. data/spec/models/remote_console_url_spec.rb +0 -34
  516. data/spec/models/request_metadata_spec.rb +0 -52
  517. data/spec/models/request_properties_spec.rb +0 -52
  518. data/spec/models/request_spec.rb +0 -58
  519. data/spec/models/request_status_metadata_spec.rb +0 -56
  520. data/spec/models/request_status_spec.rb +0 -52
  521. data/spec/models/request_target_spec.rb +0 -44
  522. data/spec/models/requests_spec.rb +0 -70
  523. data/spec/models/resource_entities_spec.rb +0 -34
  524. data/spec/models/resource_groups_spec.rb +0 -52
  525. data/spec/models/resource_limits_spec.rb +0 -160
  526. data/spec/models/resource_properties_spec.rb +0 -40
  527. data/spec/models/resource_reference_spec.rb +0 -46
  528. data/spec/models/resource_spec.rb +0 -64
  529. data/spec/models/resources_spec.rb +0 -52
  530. data/spec/models/resources_users_spec.rb +0 -52
  531. data/spec/models/s3_bucket_spec.rb +0 -34
  532. data/spec/models/s3_key_metadata_spec.rb +0 -40
  533. data/spec/models/s3_key_properties_spec.rb +0 -40
  534. data/spec/models/s3_key_spec.rb +0 -58
  535. data/spec/models/s3_keys_spec.rb +0 -52
  536. data/spec/models/s3_object_storage_sso_spec.rb +0 -34
  537. data/spec/models/server_entities_spec.rb +0 -46
  538. data/spec/models/server_properties_spec.rb +0 -96
  539. data/spec/models/server_spec.rb +0 -64
  540. data/spec/models/servers_spec.rb +0 -70
  541. data/spec/models/snapshot_properties_spec.rb +0 -128
  542. data/spec/models/snapshot_spec.rb +0 -58
  543. data/spec/models/snapshots_spec.rb +0 -52
  544. data/spec/models/target_port_range_spec.rb +0 -40
  545. data/spec/models/template_properties_spec.rb +0 -52
  546. data/spec/models/template_spec.rb +0 -58
  547. data/spec/models/templates_spec.rb +0 -52
  548. data/spec/models/token_spec.rb +0 -34
  549. data/spec/models/type_spec.rb +0 -28
  550. data/spec/models/user_metadata_spec.rb +0 -46
  551. data/spec/models/user_post_spec.rb +0 -34
  552. data/spec/models/user_properties_post_spec.rb +0 -76
  553. data/spec/models/user_properties_put_spec.rb +0 -70
  554. data/spec/models/user_properties_spec.rb +0 -76
  555. data/spec/models/user_put_spec.rb +0 -40
  556. data/spec/models/user_spec.rb +0 -64
  557. data/spec/models/users_entities_spec.rb +0 -40
  558. data/spec/models/users_spec.rb +0 -70
  559. data/spec/models/volume_properties_spec.rb +0 -164
  560. data/spec/models/volume_spec.rb +0 -58
  561. data/spec/models/volumes_spec.rb +0 -70
@@ -4,39 +4,39 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**um_groups_delete**](UserManagementApi.md#um_groups_delete) | **DELETE** /um/groups/{groupId} | Delete a Group |
8
- | [**um_groups_find_by_id**](UserManagementApi.md#um_groups_find_by_id) | **GET** /um/groups/{groupId} | Retrieve a Group |
9
- | [**um_groups_get**](UserManagementApi.md#um_groups_get) | **GET** /um/groups | List All Groups. |
10
- | [**um_groups_post**](UserManagementApi.md#um_groups_post) | **POST** /um/groups | Create a Group |
11
- | [**um_groups_put**](UserManagementApi.md#um_groups_put) | **PUT** /um/groups/{groupId} | Modify a group |
12
- | [**um_groups_resources_get**](UserManagementApi.md#um_groups_resources_get) | **GET** /um/groups/{groupId}/resources | Retrieve resources assigned to a group |
13
- | [**um_groups_shares_delete**](UserManagementApi.md#um_groups_shares_delete) | **DELETE** /um/groups/{groupId}/shares/{resourceId} | Remove a resource from a group |
14
- | [**um_groups_shares_find_by_resource_id**](UserManagementApi.md#um_groups_shares_find_by_resource_id) | **GET** /um/groups/{groupId}/shares/{resourceId} | Retrieve a group share |
15
- | [**um_groups_shares_get**](UserManagementApi.md#um_groups_shares_get) | **GET** /um/groups/{groupId}/shares | List Group Shares |
16
- | [**um_groups_shares_post**](UserManagementApi.md#um_groups_shares_post) | **POST** /um/groups/{groupId}/shares/{resourceId} | Add a resource to a group |
17
- | [**um_groups_shares_put**](UserManagementApi.md#um_groups_shares_put) | **PUT** /um/groups/{groupId}/shares/{resourceId} | Modify resource permissions of a group |
18
- | [**um_groups_users_delete**](UserManagementApi.md#um_groups_users_delete) | **DELETE** /um/groups/{groupId}/users/{userId} | Remove a user from a group |
19
- | [**um_groups_users_get**](UserManagementApi.md#um_groups_users_get) | **GET** /um/groups/{groupId}/users | List Group Members |
20
- | [**um_groups_users_post**](UserManagementApi.md#um_groups_users_post) | **POST** /um/groups/{groupId}/users | Add a user to a group |
21
- | [**um_resources_find_by_type**](UserManagementApi.md#um_resources_find_by_type) | **GET** /um/resources/{resourceType} | Retrieve a list of Resources by type. |
22
- | [**um_resources_find_by_type_and_id**](UserManagementApi.md#um_resources_find_by_type_and_id) | **GET** /um/resources/{resourceType}/{resourceId} | Retrieve a Resource by type. |
23
- | [**um_resources_get**](UserManagementApi.md#um_resources_get) | **GET** /um/resources | List All Resources. |
24
- | [**um_users_delete**](UserManagementApi.md#um_users_delete) | **DELETE** /um/users/{userId} | Delete a User |
25
- | [**um_users_find_by_id**](UserManagementApi.md#um_users_find_by_id) | **GET** /um/users/{userId} | Retrieve a User |
26
- | [**um_users_get**](UserManagementApi.md#um_users_get) | **GET** /um/users | List all Users |
27
- | [**um_users_groups_get**](UserManagementApi.md#um_users_groups_get) | **GET** /um/users/{userId}/groups | Retrieve a User's group resources |
28
- | [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve a User's own resources |
29
- | [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create a user |
30
- | [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify a user |
7
+ | [**um_groups_delete**](UserManagementApi.md#um_groups_delete) | **DELETE** /um/groups/{groupId} | Delete groups |
8
+ | [**um_groups_find_by_id**](UserManagementApi.md#um_groups_find_by_id) | **GET** /um/groups/{groupId} | Retrieve groups |
9
+ | [**um_groups_get**](UserManagementApi.md#um_groups_get) | **GET** /um/groups | List all groups |
10
+ | [**um_groups_post**](UserManagementApi.md#um_groups_post) | **POST** /um/groups | Create groups |
11
+ | [**um_groups_put**](UserManagementApi.md#um_groups_put) | **PUT** /um/groups/{groupId} | Modify groups |
12
+ | [**um_groups_resources_get**](UserManagementApi.md#um_groups_resources_get) | **GET** /um/groups/{groupId}/resources | Retrieve group resources |
13
+ | [**um_groups_shares_delete**](UserManagementApi.md#um_groups_shares_delete) | **DELETE** /um/groups/{groupId}/shares/{resourceId} | Remove group shares |
14
+ | [**um_groups_shares_find_by_resource_id**](UserManagementApi.md#um_groups_shares_find_by_resource_id) | **GET** /um/groups/{groupId}/shares/{resourceId} | Retrieve group shares |
15
+ | [**um_groups_shares_get**](UserManagementApi.md#um_groups_shares_get) | **GET** /um/groups/{groupId}/shares | List group shares |
16
+ | [**um_groups_shares_post**](UserManagementApi.md#um_groups_shares_post) | **POST** /um/groups/{groupId}/shares/{resourceId} | Add group shares |
17
+ | [**um_groups_shares_put**](UserManagementApi.md#um_groups_shares_put) | **PUT** /um/groups/{groupId}/shares/{resourceId} | Modify group share privileges |
18
+ | [**um_groups_users_delete**](UserManagementApi.md#um_groups_users_delete) | **DELETE** /um/groups/{groupId}/users/{userId} | Remove users from groups |
19
+ | [**um_groups_users_get**](UserManagementApi.md#um_groups_users_get) | **GET** /um/groups/{groupId}/users | List group members |
20
+ | [**um_groups_users_post**](UserManagementApi.md#um_groups_users_post) | **POST** /um/groups/{groupId}/users | Add group members |
21
+ | [**um_resources_find_by_type**](UserManagementApi.md#um_resources_find_by_type) | **GET** /um/resources/{resourceType} | List resources by type |
22
+ | [**um_resources_find_by_type_and_id**](UserManagementApi.md#um_resources_find_by_type_and_id) | **GET** /um/resources/{resourceType}/{resourceId} | Retrieve resources by type |
23
+ | [**um_resources_get**](UserManagementApi.md#um_resources_get) | **GET** /um/resources | List all resources |
24
+ | [**um_users_delete**](UserManagementApi.md#um_users_delete) | **DELETE** /um/users/{userId} | Delete users |
25
+ | [**um_users_find_by_id**](UserManagementApi.md#um_users_find_by_id) | **GET** /um/users/{userId} | Retrieve users |
26
+ | [**um_users_get**](UserManagementApi.md#um_users_get) | **GET** /um/users | List all users |
27
+ | [**um_users_groups_get**](UserManagementApi.md#um_users_groups_get) | **GET** /um/users/{userId}/groups | Retrieve group resources by user ID |
28
+ | [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve user resources by user ID |
29
+ | [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create users |
30
+ | [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify users |
31
31
 
32
32
 
33
33
  ## um_groups_delete
34
34
 
35
35
  > um_groups_delete(group_id, opts)
36
36
 
37
- Delete a Group
37
+ Delete groups
38
38
 
39
- Delete a group
39
+ Remove the specified group.
40
40
 
41
41
  ### Examples
42
42
 
@@ -56,7 +56,7 @@ Ionoscloud.configure do |config|
56
56
  end
57
57
 
58
58
  api_instance = Ionoscloud::UserManagementApi.new
59
- group_id = 'group_id_example' # String | The unique ID of the group
59
+ group_id = 'group_id_example' # String | The unique ID of the group.
60
60
  opts = {
61
61
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
62
62
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -64,7 +64,7 @@ opts = {
64
64
  }
65
65
 
66
66
  begin
67
- # Delete a Group
67
+ # Delete groups
68
68
  api_instance.um_groups_delete(group_id, opts)
69
69
  rescue Ionoscloud::ApiError => e
70
70
  puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
@@ -79,7 +79,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
79
79
 
80
80
  ```ruby
81
81
  begin
82
- # Delete a Group
82
+ # Delete groups
83
83
  data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
84
84
  p status_code # => 2xx
85
85
  p headers # => { ... }
@@ -93,7 +93,7 @@ end
93
93
 
94
94
  | Name | Type | Description | Notes |
95
95
  | ---- | ---- | ----------- | ----- |
96
- | **group_id** | **String** | The unique ID of the group | |
96
+ | **group_id** | **String** | The unique ID of the group. | |
97
97
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
98
98
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
99
99
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
@@ -116,9 +116,9 @@ Basic Authentication, Token Authentication
116
116
 
117
117
  > <Group> um_groups_find_by_id(group_id, opts)
118
118
 
119
- Retrieve a Group
119
+ Retrieve groups
120
120
 
121
- You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
121
+ Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
122
122
 
123
123
  ### Examples
124
124
 
@@ -138,7 +138,7 @@ Ionoscloud.configure do |config|
138
138
  end
139
139
 
140
140
  api_instance = Ionoscloud::UserManagementApi.new
141
- group_id = 'group_id_example' # String | The unique ID of the group
141
+ group_id = 'group_id_example' # String | The unique ID of the group.
142
142
  opts = {
143
143
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
144
144
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -146,7 +146,7 @@ opts = {
146
146
  }
147
147
 
148
148
  begin
149
- # Retrieve a Group
149
+ # Retrieve groups
150
150
  result = api_instance.um_groups_find_by_id(group_id, opts)
151
151
  p result
152
152
  rescue Ionoscloud::ApiError => e
@@ -162,7 +162,7 @@ This returns an Array which contains the response data, status code and headers.
162
162
 
163
163
  ```ruby
164
164
  begin
165
- # Retrieve a Group
165
+ # Retrieve groups
166
166
  data, status_code, headers = api_instance.um_groups_find_by_id_with_http_info(group_id, opts)
167
167
  p status_code # => 2xx
168
168
  p headers # => { ... }
@@ -176,14 +176,14 @@ end
176
176
 
177
177
  | Name | Type | Description | Notes |
178
178
  | ---- | ---- | ----------- | ----- |
179
- | **group_id** | **String** | The unique ID of the group | |
179
+ | **group_id** | **String** | The unique ID of the group. | |
180
180
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
181
181
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
182
182
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
183
183
 
184
184
  ### Return type
185
185
 
186
- [**Group**](Group.md)
186
+ [**Group**](../models/Group.md)
187
187
 
188
188
  ### Authorization
189
189
 
@@ -199,9 +199,9 @@ Basic Authentication, Token Authentication
199
199
 
200
200
  > <Groups> um_groups_get(opts)
201
201
 
202
- List All Groups.
202
+ List all groups
203
203
 
204
- You can retrieve a complete list of all groups that you have access to
204
+ List all the available user groups.
205
205
 
206
206
  ### Examples
207
207
 
@@ -228,7 +228,7 @@ opts = {
228
228
  }
229
229
 
230
230
  begin
231
- # List All Groups.
231
+ # List all groups
232
232
  result = api_instance.um_groups_get(opts)
233
233
  p result
234
234
  rescue Ionoscloud::ApiError => e
@@ -244,7 +244,7 @@ This returns an Array which contains the response data, status code and headers.
244
244
 
245
245
  ```ruby
246
246
  begin
247
- # List All Groups.
247
+ # List all groups
248
248
  data, status_code, headers = api_instance.um_groups_get_with_http_info(opts)
249
249
  p status_code # => 2xx
250
250
  p headers # => { ... }
@@ -264,7 +264,7 @@ end
264
264
 
265
265
  ### Return type
266
266
 
267
- [**Groups**](Groups.md)
267
+ [**Groups**](../models/Groups.md)
268
268
 
269
269
  ### Authorization
270
270
 
@@ -280,9 +280,9 @@ Basic Authentication, Token Authentication
280
280
 
281
281
  > <Group> um_groups_post(group, opts)
282
282
 
283
- Create a Group
283
+ Create groups
284
284
 
285
- You can use this POST method to create a group
285
+ Create a group.
286
286
 
287
287
  ### Examples
288
288
 
@@ -302,7 +302,7 @@ Ionoscloud.configure do |config|
302
302
  end
303
303
 
304
304
  api_instance = Ionoscloud::UserManagementApi.new
305
- group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Group to be created
305
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The group to create.
306
306
  opts = {
307
307
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
308
308
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -310,7 +310,7 @@ opts = {
310
310
  }
311
311
 
312
312
  begin
313
- # Create a Group
313
+ # Create groups
314
314
  result = api_instance.um_groups_post(group, opts)
315
315
  p result
316
316
  rescue Ionoscloud::ApiError => e
@@ -326,7 +326,7 @@ This returns an Array which contains the response data, status code and headers.
326
326
 
327
327
  ```ruby
328
328
  begin
329
- # Create a Group
329
+ # Create groups
330
330
  data, status_code, headers = api_instance.um_groups_post_with_http_info(group, opts)
331
331
  p status_code # => 2xx
332
332
  p headers # => { ... }
@@ -340,14 +340,14 @@ end
340
340
 
341
341
  | Name | Type | Description | Notes |
342
342
  | ---- | ---- | ----------- | ----- |
343
- | **group** | [**Group**](Group.md) | Group to be created | |
343
+ | **group** | [**Group**](Group.md) | The group to create. | |
344
344
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
345
345
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
346
346
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
347
347
 
348
348
  ### Return type
349
349
 
350
- [**Group**](Group.md)
350
+ [**Group**](../models/Group.md)
351
351
 
352
352
  ### Authorization
353
353
 
@@ -363,9 +363,9 @@ Basic Authentication, Token Authentication
363
363
 
364
364
  > <Group> um_groups_put(group_id, group, opts)
365
365
 
366
- Modify a group
366
+ Modify groups
367
367
 
368
- You can use this method to update properties of the group.
368
+ Modify the properties of the specified group.
369
369
 
370
370
  ### Examples
371
371
 
@@ -385,8 +385,8 @@ Ionoscloud.configure do |config|
385
385
  end
386
386
 
387
387
  api_instance = Ionoscloud::UserManagementApi.new
388
- group_id = 'group_id_example' # String | The unique ID of the group
389
- group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Modified properties of the Group
388
+ group_id = 'group_id_example' # String | The unique ID of the group.
389
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The modified group.
390
390
  opts = {
391
391
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
392
392
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -394,7 +394,7 @@ opts = {
394
394
  }
395
395
 
396
396
  begin
397
- # Modify a group
397
+ # Modify groups
398
398
  result = api_instance.um_groups_put(group_id, group, opts)
399
399
  p result
400
400
  rescue Ionoscloud::ApiError => e
@@ -410,7 +410,7 @@ This returns an Array which contains the response data, status code and headers.
410
410
 
411
411
  ```ruby
412
412
  begin
413
- # Modify a group
413
+ # Modify groups
414
414
  data, status_code, headers = api_instance.um_groups_put_with_http_info(group_id, group, opts)
415
415
  p status_code # => 2xx
416
416
  p headers # => { ... }
@@ -424,15 +424,15 @@ end
424
424
 
425
425
  | Name | Type | Description | Notes |
426
426
  | ---- | ---- | ----------- | ----- |
427
- | **group_id** | **String** | The unique ID of the group | |
428
- | **group** | [**Group**](Group.md) | Modified properties of the Group | |
427
+ | **group_id** | **String** | The unique ID of the group. | |
428
+ | **group** | [**Group**](Group.md) | The modified group. | |
429
429
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
430
430
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
431
431
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
432
432
 
433
433
  ### Return type
434
434
 
435
- [**Group**](Group.md)
435
+ [**Group**](../models/Group.md)
436
436
 
437
437
  ### Authorization
438
438
 
@@ -448,7 +448,9 @@ Basic Authentication, Token Authentication
448
448
 
449
449
  > <ResourceGroups> um_groups_resources_get(group_id, opts)
450
450
 
451
- Retrieve resources assigned to a group
451
+ Retrieve group resources
452
+
453
+ List the resources assigned to the group, by group ID.
452
454
 
453
455
  ### Examples
454
456
 
@@ -468,7 +470,7 @@ Ionoscloud.configure do |config|
468
470
  end
469
471
 
470
472
  api_instance = Ionoscloud::UserManagementApi.new
471
- group_id = 'group_id_example' # String | The unique ID of the group
473
+ group_id = 'group_id_example' # String | The unique ID of the group.
472
474
  opts = {
473
475
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
474
476
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -476,7 +478,7 @@ opts = {
476
478
  }
477
479
 
478
480
  begin
479
- # Retrieve resources assigned to a group
481
+ # Retrieve group resources
480
482
  result = api_instance.um_groups_resources_get(group_id, opts)
481
483
  p result
482
484
  rescue Ionoscloud::ApiError => e
@@ -492,7 +494,7 @@ This returns an Array which contains the response data, status code and headers.
492
494
 
493
495
  ```ruby
494
496
  begin
495
- # Retrieve resources assigned to a group
497
+ # Retrieve group resources
496
498
  data, status_code, headers = api_instance.um_groups_resources_get_with_http_info(group_id, opts)
497
499
  p status_code # => 2xx
498
500
  p headers # => { ... }
@@ -506,14 +508,14 @@ end
506
508
 
507
509
  | Name | Type | Description | Notes |
508
510
  | ---- | ---- | ----------- | ----- |
509
- | **group_id** | **String** | The unique ID of the group | |
511
+ | **group_id** | **String** | The unique ID of the group. | |
510
512
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
511
513
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
512
514
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
513
515
 
514
516
  ### Return type
515
517
 
516
- [**ResourceGroups**](ResourceGroups.md)
518
+ [**ResourceGroups**](../models/ResourceGroups.md)
517
519
 
518
520
  ### Authorization
519
521
 
@@ -529,9 +531,9 @@ Basic Authentication, Token Authentication
529
531
 
530
532
  > um_groups_shares_delete(group_id, resource_id, opts)
531
533
 
532
- Remove a resource from a group
534
+ Remove group shares
533
535
 
534
- This will remove a resource from a group
536
+ Remove the specified share from the group.
535
537
 
536
538
  ### Examples
537
539
 
@@ -551,8 +553,8 @@ Ionoscloud.configure do |config|
551
553
  end
552
554
 
553
555
  api_instance = Ionoscloud::UserManagementApi.new
554
- group_id = 'group_id_example' # String |
555
- resource_id = 'resource_id_example' # String |
556
+ group_id = 'group_id_example' # String | The unique ID of the group.
557
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
556
558
  opts = {
557
559
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
558
560
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -560,7 +562,7 @@ opts = {
560
562
  }
561
563
 
562
564
  begin
563
- # Remove a resource from a group
565
+ # Remove group shares
564
566
  api_instance.um_groups_shares_delete(group_id, resource_id, opts)
565
567
  rescue Ionoscloud::ApiError => e
566
568
  puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
@@ -575,7 +577,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
575
577
 
576
578
  ```ruby
577
579
  begin
578
- # Remove a resource from a group
580
+ # Remove group shares
579
581
  data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
580
582
  p status_code # => 2xx
581
583
  p headers # => { ... }
@@ -589,8 +591,8 @@ end
589
591
 
590
592
  | Name | Type | Description | Notes |
591
593
  | ---- | ---- | ----------- | ----- |
592
- | **group_id** | **String** | | |
593
- | **resource_id** | **String** | | |
594
+ | **group_id** | **String** | The unique ID of the group. | |
595
+ | **resource_id** | **String** | The unique ID of the resource. | |
594
596
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
595
597
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
596
598
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
@@ -613,9 +615,9 @@ Basic Authentication, Token Authentication
613
615
 
614
616
  > <GroupShare> um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
615
617
 
616
- Retrieve a group share
618
+ Retrieve group shares
617
619
 
618
- This will retrieve the properties of a group share.
620
+ Retrieve the properties of the specified group share.
619
621
 
620
622
  ### Examples
621
623
 
@@ -635,8 +637,8 @@ Ionoscloud.configure do |config|
635
637
  end
636
638
 
637
639
  api_instance = Ionoscloud::UserManagementApi.new
638
- group_id = 'group_id_example' # String |
639
- resource_id = 'resource_id_example' # String |
640
+ group_id = 'group_id_example' # String | The unique ID of the group.
641
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
640
642
  opts = {
641
643
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
642
644
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -644,7 +646,7 @@ opts = {
644
646
  }
645
647
 
646
648
  begin
647
- # Retrieve a group share
649
+ # Retrieve group shares
648
650
  result = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
649
651
  p result
650
652
  rescue Ionoscloud::ApiError => e
@@ -660,7 +662,7 @@ This returns an Array which contains the response data, status code and headers.
660
662
 
661
663
  ```ruby
662
664
  begin
663
- # Retrieve a group share
665
+ # Retrieve group shares
664
666
  data, status_code, headers = api_instance.um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
665
667
  p status_code # => 2xx
666
668
  p headers # => { ... }
@@ -674,15 +676,15 @@ end
674
676
 
675
677
  | Name | Type | Description | Notes |
676
678
  | ---- | ---- | ----------- | ----- |
677
- | **group_id** | **String** | | |
678
- | **resource_id** | **String** | | |
679
+ | **group_id** | **String** | The unique ID of the group. | |
680
+ | **resource_id** | **String** | The unique ID of the resource. | |
679
681
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
680
682
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
681
683
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
682
684
 
683
685
  ### Return type
684
686
 
685
- [**GroupShare**](GroupShare.md)
687
+ [**GroupShare**](../models/GroupShare.md)
686
688
 
687
689
  ### Authorization
688
690
 
@@ -698,9 +700,9 @@ Basic Authentication, Token Authentication
698
700
 
699
701
  > <GroupShares> um_groups_shares_get(group_id, opts)
700
702
 
701
- List Group Shares
703
+ List group shares
702
704
 
703
- You can retrieve a list of all resources along with their permissions of the group
705
+ List all shares and share privileges for the specified group.
704
706
 
705
707
  ### Examples
706
708
 
@@ -720,7 +722,7 @@ Ionoscloud.configure do |config|
720
722
  end
721
723
 
722
724
  api_instance = Ionoscloud::UserManagementApi.new
723
- group_id = 'group_id_example' # String |
725
+ group_id = 'group_id_example' # String | The unique ID of the group.
724
726
  opts = {
725
727
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
726
728
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -728,7 +730,7 @@ opts = {
728
730
  }
729
731
 
730
732
  begin
731
- # List Group Shares
733
+ # List group shares
732
734
  result = api_instance.um_groups_shares_get(group_id, opts)
733
735
  p result
734
736
  rescue Ionoscloud::ApiError => e
@@ -744,7 +746,7 @@ This returns an Array which contains the response data, status code and headers.
744
746
 
745
747
  ```ruby
746
748
  begin
747
- # List Group Shares
749
+ # List group shares
748
750
  data, status_code, headers = api_instance.um_groups_shares_get_with_http_info(group_id, opts)
749
751
  p status_code # => 2xx
750
752
  p headers # => { ... }
@@ -758,14 +760,14 @@ end
758
760
 
759
761
  | Name | Type | Description | Notes |
760
762
  | ---- | ---- | ----------- | ----- |
761
- | **group_id** | **String** | | |
763
+ | **group_id** | **String** | The unique ID of the group. | |
762
764
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
763
765
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
764
766
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
765
767
 
766
768
  ### Return type
767
769
 
768
- [**GroupShares**](GroupShares.md)
770
+ [**GroupShares**](../models/GroupShares.md)
769
771
 
770
772
  ### Authorization
771
773
 
@@ -781,9 +783,9 @@ Basic Authentication, Token Authentication
781
783
 
782
784
  > <GroupShare> um_groups_shares_post(group_id, resource_id, resource, opts)
783
785
 
784
- Add a resource to a group
786
+ Add group shares
785
787
 
786
- This will add a resource to the group.
788
+ Add the specified share to the group.
787
789
 
788
790
  ### Examples
789
791
 
@@ -803,9 +805,9 @@ Ionoscloud.configure do |config|
803
805
  end
804
806
 
805
807
  api_instance = Ionoscloud::UserManagementApi.new
806
- group_id = 'group_id_example' # String |
807
- resource_id = 'resource_id_example' # String |
808
- resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Resource to be added
808
+ group_id = 'group_id_example' # String | The unique ID of the group.
809
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
810
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The resource to add.
809
811
  opts = {
810
812
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
811
813
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -813,7 +815,7 @@ opts = {
813
815
  }
814
816
 
815
817
  begin
816
- # Add a resource to a group
818
+ # Add group shares
817
819
  result = api_instance.um_groups_shares_post(group_id, resource_id, resource, opts)
818
820
  p result
819
821
  rescue Ionoscloud::ApiError => e
@@ -829,7 +831,7 @@ This returns an Array which contains the response data, status code and headers.
829
831
 
830
832
  ```ruby
831
833
  begin
832
- # Add a resource to a group
834
+ # Add group shares
833
835
  data, status_code, headers = api_instance.um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
834
836
  p status_code # => 2xx
835
837
  p headers # => { ... }
@@ -843,16 +845,16 @@ end
843
845
 
844
846
  | Name | Type | Description | Notes |
845
847
  | ---- | ---- | ----------- | ----- |
846
- | **group_id** | **String** | | |
847
- | **resource_id** | **String** | | |
848
- | **resource** | [**GroupShare**](GroupShare.md) | Resource to be added | |
848
+ | **group_id** | **String** | The unique ID of the group. | |
849
+ | **resource_id** | **String** | The unique ID of the resource. | |
850
+ | **resource** | [**GroupShare**](GroupShare.md) | The resource to add. | |
849
851
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
850
852
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
851
853
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
852
854
 
853
855
  ### Return type
854
856
 
855
- [**GroupShare**](GroupShare.md)
857
+ [**GroupShare**](../models/GroupShare.md)
856
858
 
857
859
  ### Authorization
858
860
 
@@ -868,9 +870,9 @@ Basic Authentication, Token Authentication
868
870
 
869
871
  > <GroupShare> um_groups_shares_put(group_id, resource_id, resource, opts)
870
872
 
871
- Modify resource permissions of a group
873
+ Modify group share privileges
872
874
 
873
- You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
875
+ Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
874
876
 
875
877
  ### Examples
876
878
 
@@ -890,9 +892,9 @@ Ionoscloud.configure do |config|
890
892
  end
891
893
 
892
894
  api_instance = Ionoscloud::UserManagementApi.new
893
- group_id = 'group_id_example' # String |
894
- resource_id = 'resource_id_example' # String |
895
- resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Modified Resource
895
+ group_id = 'group_id_example' # String | The unique ID of the group.
896
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
897
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The modified resource
896
898
  opts = {
897
899
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
898
900
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -900,7 +902,7 @@ opts = {
900
902
  }
901
903
 
902
904
  begin
903
- # Modify resource permissions of a group
905
+ # Modify group share privileges
904
906
  result = api_instance.um_groups_shares_put(group_id, resource_id, resource, opts)
905
907
  p result
906
908
  rescue Ionoscloud::ApiError => e
@@ -916,7 +918,7 @@ This returns an Array which contains the response data, status code and headers.
916
918
 
917
919
  ```ruby
918
920
  begin
919
- # Modify resource permissions of a group
921
+ # Modify group share privileges
920
922
  data, status_code, headers = api_instance.um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
921
923
  p status_code # => 2xx
922
924
  p headers # => { ... }
@@ -930,16 +932,16 @@ end
930
932
 
931
933
  | Name | Type | Description | Notes |
932
934
  | ---- | ---- | ----------- | ----- |
933
- | **group_id** | **String** | | |
934
- | **resource_id** | **String** | | |
935
- | **resource** | [**GroupShare**](GroupShare.md) | Modified Resource | |
935
+ | **group_id** | **String** | The unique ID of the group. | |
936
+ | **resource_id** | **String** | The unique ID of the resource. | |
937
+ | **resource** | [**GroupShare**](GroupShare.md) | The modified resource | |
936
938
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
937
939
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
938
940
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
939
941
 
940
942
  ### Return type
941
943
 
942
- [**GroupShare**](GroupShare.md)
944
+ [**GroupShare**](../models/GroupShare.md)
943
945
 
944
946
  ### Authorization
945
947
 
@@ -955,9 +957,9 @@ Basic Authentication, Token Authentication
955
957
 
956
958
  > um_groups_users_delete(group_id, user_id, opts)
957
959
 
958
- Remove a user from a group
960
+ Remove users from groups
959
961
 
960
- This will remove a user from a group.
962
+ Remove the specified user from the group.
961
963
 
962
964
  ### Examples
963
965
 
@@ -977,8 +979,8 @@ Ionoscloud.configure do |config|
977
979
  end
978
980
 
979
981
  api_instance = Ionoscloud::UserManagementApi.new
980
- group_id = 'group_id_example' # String |
981
- user_id = 'user_id_example' # String |
982
+ group_id = 'group_id_example' # String | The unique ID of the group.
983
+ user_id = 'user_id_example' # String | The unique ID of the user.
982
984
  opts = {
983
985
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
984
986
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -986,7 +988,7 @@ opts = {
986
988
  }
987
989
 
988
990
  begin
989
- # Remove a user from a group
991
+ # Remove users from groups
990
992
  api_instance.um_groups_users_delete(group_id, user_id, opts)
991
993
  rescue Ionoscloud::ApiError => e
992
994
  puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}"
@@ -1001,7 +1003,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
1001
1003
 
1002
1004
  ```ruby
1003
1005
  begin
1004
- # Remove a user from a group
1006
+ # Remove users from groups
1005
1007
  data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts)
1006
1008
  p status_code # => 2xx
1007
1009
  p headers # => { ... }
@@ -1015,8 +1017,8 @@ end
1015
1017
 
1016
1018
  | Name | Type | Description | Notes |
1017
1019
  | ---- | ---- | ----------- | ----- |
1018
- | **group_id** | **String** | | |
1019
- | **user_id** | **String** | | |
1020
+ | **group_id** | **String** | The unique ID of the group. | |
1021
+ | **user_id** | **String** | The unique ID of the user. | |
1020
1022
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1021
1023
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1022
1024
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
@@ -1039,9 +1041,9 @@ Basic Authentication, Token Authentication
1039
1041
 
1040
1042
  > <GroupMembers> um_groups_users_get(group_id, opts)
1041
1043
 
1042
- List Group Members
1044
+ List group members
1043
1045
 
1044
- You can retrieve a list of users who are members of the group
1046
+ List all members of the specified user group.
1045
1047
 
1046
1048
  ### Examples
1047
1049
 
@@ -1061,7 +1063,7 @@ Ionoscloud.configure do |config|
1061
1063
  end
1062
1064
 
1063
1065
  api_instance = Ionoscloud::UserManagementApi.new
1064
- group_id = 'group_id_example' # String |
1066
+ group_id = 'group_id_example' # String | The unique ID of the group.
1065
1067
  opts = {
1066
1068
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1067
1069
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1069,7 +1071,7 @@ opts = {
1069
1071
  }
1070
1072
 
1071
1073
  begin
1072
- # List Group Members
1074
+ # List group members
1073
1075
  result = api_instance.um_groups_users_get(group_id, opts)
1074
1076
  p result
1075
1077
  rescue Ionoscloud::ApiError => e
@@ -1085,7 +1087,7 @@ This returns an Array which contains the response data, status code and headers.
1085
1087
 
1086
1088
  ```ruby
1087
1089
  begin
1088
- # List Group Members
1090
+ # List group members
1089
1091
  data, status_code, headers = api_instance.um_groups_users_get_with_http_info(group_id, opts)
1090
1092
  p status_code # => 2xx
1091
1093
  p headers # => { ... }
@@ -1099,14 +1101,14 @@ end
1099
1101
 
1100
1102
  | Name | Type | Description | Notes |
1101
1103
  | ---- | ---- | ----------- | ----- |
1102
- | **group_id** | **String** | | |
1104
+ | **group_id** | **String** | The unique ID of the group. | |
1103
1105
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1104
1106
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1105
1107
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1106
1108
 
1107
1109
  ### Return type
1108
1110
 
1109
- [**GroupMembers**](GroupMembers.md)
1111
+ [**GroupMembers**](../models/GroupMembers.md)
1110
1112
 
1111
1113
  ### Authorization
1112
1114
 
@@ -1122,9 +1124,9 @@ Basic Authentication, Token Authentication
1122
1124
 
1123
1125
  > <User> um_groups_users_post(group_id, user, opts)
1124
1126
 
1125
- Add a user to a group
1127
+ Add group members
1126
1128
 
1127
- This will attach a pre-existing user to a group.
1129
+ Add an existing user to the specified group.
1128
1130
 
1129
1131
  ### Examples
1130
1132
 
@@ -1144,8 +1146,8 @@ Ionoscloud.configure do |config|
1144
1146
  end
1145
1147
 
1146
1148
  api_instance = Ionoscloud::UserManagementApi.new
1147
- group_id = 'group_id_example' # String |
1148
- user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | User to be added
1149
+ group_id = 'group_id_example' # String | The unique ID of the group.
1150
+ user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | The user to add.
1149
1151
  opts = {
1150
1152
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1151
1153
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1153,7 +1155,7 @@ opts = {
1153
1155
  }
1154
1156
 
1155
1157
  begin
1156
- # Add a user to a group
1158
+ # Add group members
1157
1159
  result = api_instance.um_groups_users_post(group_id, user, opts)
1158
1160
  p result
1159
1161
  rescue Ionoscloud::ApiError => e
@@ -1169,7 +1171,7 @@ This returns an Array which contains the response data, status code and headers.
1169
1171
 
1170
1172
  ```ruby
1171
1173
  begin
1172
- # Add a user to a group
1174
+ # Add group members
1173
1175
  data, status_code, headers = api_instance.um_groups_users_post_with_http_info(group_id, user, opts)
1174
1176
  p status_code # => 2xx
1175
1177
  p headers # => { ... }
@@ -1183,15 +1185,15 @@ end
1183
1185
 
1184
1186
  | Name | Type | Description | Notes |
1185
1187
  | ---- | ---- | ----------- | ----- |
1186
- | **group_id** | **String** | | |
1187
- | **user** | [**User**](User.md) | User to be added | |
1188
+ | **group_id** | **String** | The unique ID of the group. | |
1189
+ | **user** | [**User**](User.md) | The user to add. | |
1188
1190
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1189
1191
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1190
1192
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1191
1193
 
1192
1194
  ### Return type
1193
1195
 
1194
- [**User**](User.md)
1196
+ [**User**](../models/User.md)
1195
1197
 
1196
1198
  ### Authorization
1197
1199
 
@@ -1207,9 +1209,9 @@ Basic Authentication, Token Authentication
1207
1209
 
1208
1210
  > <Resources> um_resources_find_by_type(resource_type, opts)
1209
1211
 
1210
- Retrieve a list of Resources by type.
1212
+ List resources by type
1211
1213
 
1212
- You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.
1214
+ List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
1213
1215
 
1214
1216
  ### Examples
1215
1217
 
@@ -1229,7 +1231,7 @@ Ionoscloud.configure do |config|
1229
1231
  end
1230
1232
 
1231
1233
  api_instance = Ionoscloud::UserManagementApi.new
1232
- resource_type = 'resource_type_example' # String | The resource Type
1234
+ resource_type = 'resource_type_example' # String | The resource type
1233
1235
  opts = {
1234
1236
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1235
1237
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1237,7 +1239,7 @@ opts = {
1237
1239
  }
1238
1240
 
1239
1241
  begin
1240
- # Retrieve a list of Resources by type.
1242
+ # List resources by type
1241
1243
  result = api_instance.um_resources_find_by_type(resource_type, opts)
1242
1244
  p result
1243
1245
  rescue Ionoscloud::ApiError => e
@@ -1253,7 +1255,7 @@ This returns an Array which contains the response data, status code and headers.
1253
1255
 
1254
1256
  ```ruby
1255
1257
  begin
1256
- # Retrieve a list of Resources by type.
1258
+ # List resources by type
1257
1259
  data, status_code, headers = api_instance.um_resources_find_by_type_with_http_info(resource_type, opts)
1258
1260
  p status_code # => 2xx
1259
1261
  p headers # => { ... }
@@ -1267,14 +1269,14 @@ end
1267
1269
 
1268
1270
  | Name | Type | Description | Notes |
1269
1271
  | ---- | ---- | ----------- | ----- |
1270
- | **resource_type** | **String** | The resource Type | |
1272
+ | **resource_type** | **String** | The resource type | |
1271
1273
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1272
1274
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1273
1275
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1274
1276
 
1275
1277
  ### Return type
1276
1278
 
1277
- [**Resources**](Resources.md)
1279
+ [**Resources**](../models/Resources.md)
1278
1280
 
1279
1281
  ### Authorization
1280
1282
 
@@ -1290,9 +1292,9 @@ Basic Authentication, Token Authentication
1290
1292
 
1291
1293
  > <Resource> um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1292
1294
 
1293
- Retrieve a Resource by type.
1295
+ Retrieve resources by type
1294
1296
 
1295
- You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. The value of resource type can also be found in the response body when you GET a list of all resources.
1297
+ Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
1296
1298
 
1297
1299
  ### Examples
1298
1300
 
@@ -1312,8 +1314,8 @@ Ionoscloud.configure do |config|
1312
1314
  end
1313
1315
 
1314
1316
  api_instance = Ionoscloud::UserManagementApi.new
1315
- resource_type = 'resource_type_example' # String | The resource Type
1316
- resource_id = 'resource_id_example' # String | The resource Uuid
1317
+ resource_type = 'resource_type_example' # String | The resource type
1318
+ resource_id = 'resource_id_example' # String | The resource ID
1317
1319
  opts = {
1318
1320
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1319
1321
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1321,7 +1323,7 @@ opts = {
1321
1323
  }
1322
1324
 
1323
1325
  begin
1324
- # Retrieve a Resource by type.
1326
+ # Retrieve resources by type
1325
1327
  result = api_instance.um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1326
1328
  p result
1327
1329
  rescue Ionoscloud::ApiError => e
@@ -1337,7 +1339,7 @@ This returns an Array which contains the response data, status code and headers.
1337
1339
 
1338
1340
  ```ruby
1339
1341
  begin
1340
- # Retrieve a Resource by type.
1342
+ # Retrieve resources by type
1341
1343
  data, status_code, headers = api_instance.um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
1342
1344
  p status_code # => 2xx
1343
1345
  p headers # => { ... }
@@ -1351,15 +1353,15 @@ end
1351
1353
 
1352
1354
  | Name | Type | Description | Notes |
1353
1355
  | ---- | ---- | ----------- | ----- |
1354
- | **resource_type** | **String** | The resource Type | |
1355
- | **resource_id** | **String** | The resource Uuid | |
1356
+ | **resource_type** | **String** | The resource type | |
1357
+ | **resource_id** | **String** | The resource ID | |
1356
1358
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1357
1359
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1358
1360
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1359
1361
 
1360
1362
  ### Return type
1361
1363
 
1362
- [**Resource**](Resource.md)
1364
+ [**Resource**](../models/Resource.md)
1363
1365
 
1364
1366
  ### Authorization
1365
1367
 
@@ -1375,9 +1377,9 @@ Basic Authentication, Token Authentication
1375
1377
 
1376
1378
  > <Resources> um_resources_get(opts)
1377
1379
 
1378
- List All Resources.
1380
+ List all resources
1379
1381
 
1380
- You can retrieve a complete list of all resources that you have access to.
1382
+ List all the available resources.
1381
1383
 
1382
1384
  ### Examples
1383
1385
 
@@ -1404,7 +1406,7 @@ opts = {
1404
1406
  }
1405
1407
 
1406
1408
  begin
1407
- # List All Resources.
1409
+ # List all resources
1408
1410
  result = api_instance.um_resources_get(opts)
1409
1411
  p result
1410
1412
  rescue Ionoscloud::ApiError => e
@@ -1420,7 +1422,7 @@ This returns an Array which contains the response data, status code and headers.
1420
1422
 
1421
1423
  ```ruby
1422
1424
  begin
1423
- # List All Resources.
1425
+ # List all resources
1424
1426
  data, status_code, headers = api_instance.um_resources_get_with_http_info(opts)
1425
1427
  p status_code # => 2xx
1426
1428
  p headers # => { ... }
@@ -1440,7 +1442,7 @@ end
1440
1442
 
1441
1443
  ### Return type
1442
1444
 
1443
- [**Resources**](Resources.md)
1445
+ [**Resources**](../models/Resources.md)
1444
1446
 
1445
1447
  ### Authorization
1446
1448
 
@@ -1456,9 +1458,9 @@ Basic Authentication, Token Authentication
1456
1458
 
1457
1459
  > um_users_delete(user_id, opts)
1458
1460
 
1459
- Delete a User
1461
+ Delete users
1460
1462
 
1461
- Delete a user
1463
+ Delete the specified user.
1462
1464
 
1463
1465
  ### Examples
1464
1466
 
@@ -1478,7 +1480,7 @@ Ionoscloud.configure do |config|
1478
1480
  end
1479
1481
 
1480
1482
  api_instance = Ionoscloud::UserManagementApi.new
1481
- user_id = 'user_id_example' # String | The unique ID of the user
1483
+ user_id = 'user_id_example' # String | The unique ID of the user.
1482
1484
  opts = {
1483
1485
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1484
1486
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1486,7 +1488,7 @@ opts = {
1486
1488
  }
1487
1489
 
1488
1490
  begin
1489
- # Delete a User
1491
+ # Delete users
1490
1492
  api_instance.um_users_delete(user_id, opts)
1491
1493
  rescue Ionoscloud::ApiError => e
1492
1494
  puts "Error when calling UserManagementApi->um_users_delete: #{e}"
@@ -1501,7 +1503,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
1501
1503
 
1502
1504
  ```ruby
1503
1505
  begin
1504
- # Delete a User
1506
+ # Delete users
1505
1507
  data, status_code, headers = api_instance.um_users_delete_with_http_info(user_id, opts)
1506
1508
  p status_code # => 2xx
1507
1509
  p headers # => { ... }
@@ -1515,7 +1517,7 @@ end
1515
1517
 
1516
1518
  | Name | Type | Description | Notes |
1517
1519
  | ---- | ---- | ----------- | ----- |
1518
- | **user_id** | **String** | The unique ID of the user | |
1520
+ | **user_id** | **String** | The unique ID of the user. | |
1519
1521
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1520
1522
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1521
1523
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
@@ -1538,9 +1540,9 @@ Basic Authentication, Token Authentication
1538
1540
 
1539
1541
  > <User> um_users_find_by_id(user_id, opts)
1540
1542
 
1541
- Retrieve a User
1543
+ Retrieve users
1542
1544
 
1543
- You can retrieve user details by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1545
+ Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1544
1546
 
1545
1547
  ### Examples
1546
1548
 
@@ -1560,7 +1562,7 @@ Ionoscloud.configure do |config|
1560
1562
  end
1561
1563
 
1562
1564
  api_instance = Ionoscloud::UserManagementApi.new
1563
- user_id = 'user_id_example' # String | The unique ID of the user
1565
+ user_id = 'user_id_example' # String | The unique ID of the user.
1564
1566
  opts = {
1565
1567
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1566
1568
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1568,7 +1570,7 @@ opts = {
1568
1570
  }
1569
1571
 
1570
1572
  begin
1571
- # Retrieve a User
1573
+ # Retrieve users
1572
1574
  result = api_instance.um_users_find_by_id(user_id, opts)
1573
1575
  p result
1574
1576
  rescue Ionoscloud::ApiError => e
@@ -1584,7 +1586,7 @@ This returns an Array which contains the response data, status code and headers.
1584
1586
 
1585
1587
  ```ruby
1586
1588
  begin
1587
- # Retrieve a User
1589
+ # Retrieve users
1588
1590
  data, status_code, headers = api_instance.um_users_find_by_id_with_http_info(user_id, opts)
1589
1591
  p status_code # => 2xx
1590
1592
  p headers # => { ... }
@@ -1598,14 +1600,14 @@ end
1598
1600
 
1599
1601
  | Name | Type | Description | Notes |
1600
1602
  | ---- | ---- | ----------- | ----- |
1601
- | **user_id** | **String** | The unique ID of the user | |
1603
+ | **user_id** | **String** | The unique ID of the user. | |
1602
1604
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1603
1605
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1604
1606
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1605
1607
 
1606
1608
  ### Return type
1607
1609
 
1608
- [**User**](User.md)
1610
+ [**User**](../models/User.md)
1609
1611
 
1610
1612
  ### Authorization
1611
1613
 
@@ -1621,9 +1623,9 @@ Basic Authentication, Token Authentication
1621
1623
 
1622
1624
  > <Users> um_users_get(opts)
1623
1625
 
1624
- List all Users
1626
+ List all users
1625
1627
 
1626
- You can retrieve a complete list of users under your account
1628
+ List all the users in your account.
1627
1629
 
1628
1630
  ### Examples
1629
1631
 
@@ -1648,11 +1650,11 @@ opts = {
1648
1650
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
1649
1651
  x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1650
1652
  offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
1651
- limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
1653
+ limit: 56 # Integer | The maximum number of elements to return (use together with <code>offset</code> for pagination).
1652
1654
  }
1653
1655
 
1654
1656
  begin
1655
- # List all Users
1657
+ # List all users
1656
1658
  result = api_instance.um_users_get(opts)
1657
1659
  p result
1658
1660
  rescue Ionoscloud::ApiError => e
@@ -1668,7 +1670,7 @@ This returns an Array which contains the response data, status code and headers.
1668
1670
 
1669
1671
  ```ruby
1670
1672
  begin
1671
- # List all Users
1673
+ # List all users
1672
1674
  data, status_code, headers = api_instance.um_users_get_with_http_info(opts)
1673
1675
  p status_code # => 2xx
1674
1676
  p headers # => { ... }
@@ -1686,11 +1688,11 @@ end
1686
1688
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1687
1689
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1688
1690
  | **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
1689
- | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 100] |
1691
+ | **limit** | **Integer** | The maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination). | [optional][default to 100] |
1690
1692
 
1691
1693
  ### Return type
1692
1694
 
1693
- [**Users**](Users.md)
1695
+ [**Users**](../models/Users.md)
1694
1696
 
1695
1697
  ### Authorization
1696
1698
 
@@ -1706,9 +1708,9 @@ Basic Authentication, Token Authentication
1706
1708
 
1707
1709
  > <ResourceGroups> um_users_groups_get(user_id, opts)
1708
1710
 
1709
- Retrieve a User's group resources
1711
+ Retrieve group resources by user ID
1710
1712
 
1711
- You can retrieve group resources of user by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1713
+ Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1712
1714
 
1713
1715
  ### Examples
1714
1716
 
@@ -1728,7 +1730,7 @@ Ionoscloud.configure do |config|
1728
1730
  end
1729
1731
 
1730
1732
  api_instance = Ionoscloud::UserManagementApi.new
1731
- user_id = 'user_id_example' # String | The unique ID of the user
1733
+ user_id = 'user_id_example' # String | The unique ID of the user.
1732
1734
  opts = {
1733
1735
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1734
1736
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1736,7 +1738,7 @@ opts = {
1736
1738
  }
1737
1739
 
1738
1740
  begin
1739
- # Retrieve a User's group resources
1741
+ # Retrieve group resources by user ID
1740
1742
  result = api_instance.um_users_groups_get(user_id, opts)
1741
1743
  p result
1742
1744
  rescue Ionoscloud::ApiError => e
@@ -1752,7 +1754,7 @@ This returns an Array which contains the response data, status code and headers.
1752
1754
 
1753
1755
  ```ruby
1754
1756
  begin
1755
- # Retrieve a User's group resources
1757
+ # Retrieve group resources by user ID
1756
1758
  data, status_code, headers = api_instance.um_users_groups_get_with_http_info(user_id, opts)
1757
1759
  p status_code # => 2xx
1758
1760
  p headers # => { ... }
@@ -1766,14 +1768,14 @@ end
1766
1768
 
1767
1769
  | Name | Type | Description | Notes |
1768
1770
  | ---- | ---- | ----------- | ----- |
1769
- | **user_id** | **String** | The unique ID of the user | |
1771
+ | **user_id** | **String** | The unique ID of the user. | |
1770
1772
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1771
1773
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1772
1774
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1773
1775
 
1774
1776
  ### Return type
1775
1777
 
1776
- [**ResourceGroups**](ResourceGroups.md)
1778
+ [**ResourceGroups**](../models/ResourceGroups.md)
1777
1779
 
1778
1780
  ### Authorization
1779
1781
 
@@ -1789,9 +1791,9 @@ Basic Authentication, Token Authentication
1789
1791
 
1790
1792
  > <ResourcesUsers> um_users_owns_get(user_id, opts)
1791
1793
 
1792
- Retrieve a User's own resources
1794
+ Retrieve user resources by user ID
1793
1795
 
1794
- You can retrieve resources owned by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1796
+ Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1795
1797
 
1796
1798
  ### Examples
1797
1799
 
@@ -1811,7 +1813,7 @@ Ionoscloud.configure do |config|
1811
1813
  end
1812
1814
 
1813
1815
  api_instance = Ionoscloud::UserManagementApi.new
1814
- user_id = 'user_id_example' # String | The unique ID of the user
1816
+ user_id = 'user_id_example' # String | The unique ID of the user.
1815
1817
  opts = {
1816
1818
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1817
1819
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1819,7 +1821,7 @@ opts = {
1819
1821
  }
1820
1822
 
1821
1823
  begin
1822
- # Retrieve a User's own resources
1824
+ # Retrieve user resources by user ID
1823
1825
  result = api_instance.um_users_owns_get(user_id, opts)
1824
1826
  p result
1825
1827
  rescue Ionoscloud::ApiError => e
@@ -1835,7 +1837,7 @@ This returns an Array which contains the response data, status code and headers.
1835
1837
 
1836
1838
  ```ruby
1837
1839
  begin
1838
- # Retrieve a User's own resources
1840
+ # Retrieve user resources by user ID
1839
1841
  data, status_code, headers = api_instance.um_users_owns_get_with_http_info(user_id, opts)
1840
1842
  p status_code # => 2xx
1841
1843
  p headers # => { ... }
@@ -1849,14 +1851,14 @@ end
1849
1851
 
1850
1852
  | Name | Type | Description | Notes |
1851
1853
  | ---- | ---- | ----------- | ----- |
1852
- | **user_id** | **String** | The unique ID of the user | |
1854
+ | **user_id** | **String** | The unique ID of the user. | |
1853
1855
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1854
1856
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1855
1857
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1856
1858
 
1857
1859
  ### Return type
1858
1860
 
1859
- [**ResourcesUsers**](ResourcesUsers.md)
1861
+ [**ResourcesUsers**](../models/ResourcesUsers.md)
1860
1862
 
1861
1863
  ### Authorization
1862
1864
 
@@ -1872,9 +1874,9 @@ Basic Authentication, Token Authentication
1872
1874
 
1873
1875
  > <User> um_users_post(user, opts)
1874
1876
 
1875
- Create a user
1877
+ Create users
1876
1878
 
1877
- You can use this POST method to create a user
1879
+ Create a user.
1878
1880
 
1879
1881
  ### Examples
1880
1882
 
@@ -1894,7 +1896,7 @@ Ionoscloud.configure do |config|
1894
1896
  end
1895
1897
 
1896
1898
  api_instance = Ionoscloud::UserManagementApi.new
1897
- user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | User to be created
1899
+ user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | The user to create.
1898
1900
  opts = {
1899
1901
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1900
1902
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1902,7 +1904,7 @@ opts = {
1902
1904
  }
1903
1905
 
1904
1906
  begin
1905
- # Create a user
1907
+ # Create users
1906
1908
  result = api_instance.um_users_post(user, opts)
1907
1909
  p result
1908
1910
  rescue Ionoscloud::ApiError => e
@@ -1918,7 +1920,7 @@ This returns an Array which contains the response data, status code and headers.
1918
1920
 
1919
1921
  ```ruby
1920
1922
  begin
1921
- # Create a user
1923
+ # Create users
1922
1924
  data, status_code, headers = api_instance.um_users_post_with_http_info(user, opts)
1923
1925
  p status_code # => 2xx
1924
1926
  p headers # => { ... }
@@ -1932,14 +1934,14 @@ end
1932
1934
 
1933
1935
  | Name | Type | Description | Notes |
1934
1936
  | ---- | ---- | ----------- | ----- |
1935
- | **user** | [**UserPost**](UserPost.md) | User to be created | |
1937
+ | **user** | [**UserPost**](UserPost.md) | The user to create. | |
1936
1938
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1937
1939
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
1938
1940
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1939
1941
 
1940
1942
  ### Return type
1941
1943
 
1942
- [**User**](User.md)
1944
+ [**User**](../models/User.md)
1943
1945
 
1944
1946
  ### Authorization
1945
1947
 
@@ -1955,9 +1957,9 @@ Basic Authentication, Token Authentication
1955
1957
 
1956
1958
  > <User> um_users_put(user_id, user, opts)
1957
1959
 
1958
- Modify a user
1960
+ Modify users
1959
1961
 
1960
- You can use update attributes of a User
1962
+ Modify the properties of the specified user.
1961
1963
 
1962
1964
  ### Examples
1963
1965
 
@@ -1977,8 +1979,8 @@ Ionoscloud.configure do |config|
1977
1979
  end
1978
1980
 
1979
1981
  api_instance = Ionoscloud::UserManagementApi.new
1980
- user_id = 'user_id_example' # String |
1981
- user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | Modified user
1982
+ user_id = 'user_id_example' # String | The unique ID of the user.
1983
+ user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | The modified user
1982
1984
  opts = {
1983
1985
  pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1984
1986
  depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
@@ -1986,7 +1988,7 @@ opts = {
1986
1988
  }
1987
1989
 
1988
1990
  begin
1989
- # Modify a user
1991
+ # Modify users
1990
1992
  result = api_instance.um_users_put(user_id, user, opts)
1991
1993
  p result
1992
1994
  rescue Ionoscloud::ApiError => e
@@ -2002,7 +2004,7 @@ This returns an Array which contains the response data, status code and headers.
2002
2004
 
2003
2005
  ```ruby
2004
2006
  begin
2005
- # Modify a user
2007
+ # Modify users
2006
2008
  data, status_code, headers = api_instance.um_users_put_with_http_info(user_id, user, opts)
2007
2009
  p status_code # => 2xx
2008
2010
  p headers # => { ... }
@@ -2016,15 +2018,15 @@ end
2016
2018
 
2017
2019
  | Name | Type | Description | Notes |
2018
2020
  | ---- | ---- | ----------- | ----- |
2019
- | **user_id** | **String** | | |
2020
- | **user** | [**UserPut**](UserPut.md) | Modified user | |
2021
+ | **user_id** | **String** | The unique ID of the user. | |
2022
+ | **user** | [**UserPut**](UserPut.md) | The modified user | |
2021
2023
  | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2022
2024
  | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on | [optional][default to 0] |
2023
2025
  | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2024
2026
 
2025
2027
  ### Return type
2026
2028
 
2027
- [**User**](User.md)
2029
+ [**User**](../models/User.md)
2028
2030
 
2029
2031
  ### Authorization
2030
2032