xbim_aim 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (331) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +413 -0
  4. data/Rakefile +10 -0
  5. data/lib/xbim_aim/api/admin_api.rb +358 -0
  6. data/lib/xbim_aim/api/applications_api.rb +203 -0
  7. data/lib/xbim_aim/api/assemblies_api.rb +690 -0
  8. data/lib/xbim_aim/api/assets_api.rb +926 -0
  9. data/lib/xbim_aim/api/attributes_api.rb +789 -0
  10. data/lib/xbim_aim/api/component_types_api.rb +690 -0
  11. data/lib/xbim_aim/api/components_api.rb +803 -0
  12. data/lib/xbim_aim/api/contacts_api.rb +690 -0
  13. data/lib/xbim_aim/api/diagnostics_api.rb +109 -0
  14. data/lib/xbim_aim/api/document_files_api.rb +224 -0
  15. data/lib/xbim_aim/api/documents_api.rb +690 -0
  16. data/lib/xbim_aim/api/entities_api.rb +904 -0
  17. data/lib/xbim_aim/api/facilities_api.rb +690 -0
  18. data/lib/xbim_aim/api/issues_api.rb +690 -0
  19. data/lib/xbim_aim/api/jobs_api.rb +690 -0
  20. data/lib/xbim_aim/api/levels_api.rb +690 -0
  21. data/lib/xbim_aim/api/logs_api.rb +90 -0
  22. data/lib/xbim_aim/api/model_files_api.rb +219 -0
  23. data/lib/xbim_aim/api/model_mapping_api.rb +203 -0
  24. data/lib/xbim_aim/api/models_api.rb +1308 -0
  25. data/lib/xbim_aim/api/resources_api.rb +690 -0
  26. data/lib/xbim_aim/api/schedules_api.rb +496 -0
  27. data/lib/xbim_aim/api/sites_api.rb +690 -0
  28. data/lib/xbim_aim/api/spaces_api.rb +803 -0
  29. data/lib/xbim_aim/api/spares_api.rb +690 -0
  30. data/lib/xbim_aim/api/stats_api.rb +170 -0
  31. data/lib/xbim_aim/api/systems_api.rb +690 -0
  32. data/lib/xbim_aim/api/thumbnails_api.rb +182 -0
  33. data/lib/xbim_aim/api/wexbim_api.rb +849 -0
  34. data/lib/xbim_aim/api/zones_api.rb +690 -0
  35. data/lib/xbim_aim/api_client.rb +390 -0
  36. data/lib/xbim_aim/api_error.rb +57 -0
  37. data/lib/xbim_aim/configuration.rb +278 -0
  38. data/lib/xbim_aim/models/application.rb +277 -0
  39. data/lib/xbim_aim/models/assembly_diagnostics.rb +299 -0
  40. data/lib/xbim_aim/models/assembly_info.rb +308 -0
  41. data/lib/xbim_aim/models/assembly_item.rb +454 -0
  42. data/lib/xbim_aim/models/asset.rb +339 -0
  43. data/lib/xbim_aim/models/asset_create.rb +268 -0
  44. data/lib/xbim_aim/models/asset_edit.rb +263 -0
  45. data/lib/xbim_aim/models/asset_segment.rb +304 -0
  46. data/lib/xbim_aim/models/attribute_definition.rb +354 -0
  47. data/lib/xbim_aim/models/attribute_definition_create.rb +338 -0
  48. data/lib/xbim_aim/models/attribute_definition_edit.rb +288 -0
  49. data/lib/xbim_aim/models/attribute_definition_entity.rb +392 -0
  50. data/lib/xbim_aim/models/attribute_value.rb +333 -0
  51. data/lib/xbim_aim/models/attribute_value_entity.rb +272 -0
  52. data/lib/xbim_aim/models/cell.rb +236 -0
  53. data/lib/xbim_aim/models/classification_node.rb +254 -0
  54. data/lib/xbim_aim/models/column_definition.rb +297 -0
  55. data/lib/xbim_aim/models/complex_value_base.rb +261 -0
  56. data/lib/xbim_aim/models/component.rb +535 -0
  57. data/lib/xbim_aim/models/component_create.rb +283 -0
  58. data/lib/xbim_aim/models/component_edit.rb +248 -0
  59. data/lib/xbim_aim/models/component_info.rb +326 -0
  60. data/lib/xbim_aim/models/component_type.rb +498 -0
  61. data/lib/xbim_aim/models/component_type_info.rb +308 -0
  62. data/lib/xbim_aim/models/contact.rb +443 -0
  63. data/lib/xbim_aim/models/contact_entity.rb +333 -0
  64. data/lib/xbim_aim/models/contact_info.rb +308 -0
  65. data/lib/xbim_aim/models/db_update.rb +227 -0
  66. data/lib/xbim_aim/models/document.rb +421 -0
  67. data/lib/xbim_aim/models/document_create.rb +345 -0
  68. data/lib/xbim_aim/models/document_edit.rb +310 -0
  69. data/lib/xbim_aim/models/document_info.rb +308 -0
  70. data/lib/xbim_aim/models/entity.rb +421 -0
  71. data/lib/xbim_aim/models/entity_base.rb +308 -0
  72. data/lib/xbim_aim/models/entity_contact.rb +333 -0
  73. data/lib/xbim_aim/models/entity_create.rb +274 -0
  74. data/lib/xbim_aim/models/entity_edit.rb +239 -0
  75. data/lib/xbim_aim/models/entity_mapping_info.rb +299 -0
  76. data/lib/xbim_aim/models/entity_match_descriptor.rb +245 -0
  77. data/lib/xbim_aim/models/entity_match_info.rb +238 -0
  78. data/lib/xbim_aim/models/entity_ref.rb +281 -0
  79. data/lib/xbim_aim/models/facility.rb +432 -0
  80. data/lib/xbim_aim/models/facility_info.rb +308 -0
  81. data/lib/xbim_aim/models/file_upload_result.rb +300 -0
  82. data/lib/xbim_aim/models/footprint.rb +254 -0
  83. data/lib/xbim_aim/models/i_metered_resource.rb +254 -0
  84. data/lib/xbim_aim/models/ifc_type.rb +247 -0
  85. data/lib/xbim_aim/models/inline_object.rb +294 -0
  86. data/lib/xbim_aim/models/inline_object1.rb +294 -0
  87. data/lib/xbim_aim/models/inline_object2.rb +220 -0
  88. data/lib/xbim_aim/models/inline_object3.rb +223 -0
  89. data/lib/xbim_aim/models/inline_object4.rb +294 -0
  90. data/lib/xbim_aim/models/inline_object5.rb +294 -0
  91. data/lib/xbim_aim/models/issue.rb +443 -0
  92. data/lib/xbim_aim/models/issue_info.rb +308 -0
  93. data/lib/xbim_aim/models/job.rb +483 -0
  94. data/lib/xbim_aim/models/job_create.rb +283 -0
  95. data/lib/xbim_aim/models/job_edit.rb +248 -0
  96. data/lib/xbim_aim/models/job_info.rb +308 -0
  97. data/lib/xbim_aim/models/level.rb +463 -0
  98. data/lib/xbim_aim/models/level_create.rb +274 -0
  99. data/lib/xbim_aim/models/level_edit.rb +239 -0
  100. data/lib/xbim_aim/models/level_info.rb +308 -0
  101. data/lib/xbim_aim/models/mapping_message_info.rb +281 -0
  102. data/lib/xbim_aim/models/mapping_properties.rb +227 -0
  103. data/lib/xbim_aim/models/member_permission.rb +292 -0
  104. data/lib/xbim_aim/models/member_role.rb +320 -0
  105. data/lib/xbim_aim/models/model.rb +617 -0
  106. data/lib/xbim_aim/models/model_create.rb +318 -0
  107. data/lib/xbim_aim/models/model_edit.rb +284 -0
  108. data/lib/xbim_aim/models/model_info.rb +380 -0
  109. data/lib/xbim_aim/models/model_mapping.rb +363 -0
  110. data/lib/xbim_aim/models/model_mapping_report.rb +354 -0
  111. data/lib/xbim_aim/models/o_data_list_response_of_application.rb +247 -0
  112. data/lib/xbim_aim/models/o_data_list_response_of_assembly_diagnostics.rb +247 -0
  113. data/lib/xbim_aim/models/o_data_list_response_of_assembly_item.rb +247 -0
  114. data/lib/xbim_aim/models/o_data_list_response_of_asset.rb +247 -0
  115. data/lib/xbim_aim/models/o_data_list_response_of_attribute_definition.rb +247 -0
  116. data/lib/xbim_aim/models/o_data_list_response_of_attribute_definition_entity.rb +247 -0
  117. data/lib/xbim_aim/models/o_data_list_response_of_attribute_value.rb +247 -0
  118. data/lib/xbim_aim/models/o_data_list_response_of_complex_value_base.rb +247 -0
  119. data/lib/xbim_aim/models/o_data_list_response_of_component.rb +247 -0
  120. data/lib/xbim_aim/models/o_data_list_response_of_component_type.rb +247 -0
  121. data/lib/xbim_aim/models/o_data_list_response_of_contact.rb +247 -0
  122. data/lib/xbim_aim/models/o_data_list_response_of_document.rb +247 -0
  123. data/lib/xbim_aim/models/o_data_list_response_of_entity.rb +247 -0
  124. data/lib/xbim_aim/models/o_data_list_response_of_entity_ref.rb +247 -0
  125. data/lib/xbim_aim/models/o_data_list_response_of_facility.rb +247 -0
  126. data/lib/xbim_aim/models/o_data_list_response_of_issue.rb +247 -0
  127. data/lib/xbim_aim/models/o_data_list_response_of_job.rb +247 -0
  128. data/lib/xbim_aim/models/o_data_list_response_of_level.rb +247 -0
  129. data/lib/xbim_aim/models/o_data_list_response_of_member_permission.rb +247 -0
  130. data/lib/xbim_aim/models/o_data_list_response_of_model.rb +247 -0
  131. data/lib/xbim_aim/models/o_data_list_response_of_model_mapping.rb +247 -0
  132. data/lib/xbim_aim/models/o_data_list_response_of_model_mapping_report.rb +247 -0
  133. data/lib/xbim_aim/models/o_data_list_response_of_resource.rb +247 -0
  134. data/lib/xbim_aim/models/o_data_list_response_of_role.rb +247 -0
  135. data/lib/xbim_aim/models/o_data_list_response_of_row.rb +247 -0
  136. data/lib/xbim_aim/models/o_data_list_response_of_schedule.rb +247 -0
  137. data/lib/xbim_aim/models/o_data_list_response_of_site.rb +247 -0
  138. data/lib/xbim_aim/models/o_data_list_response_of_space.rb +247 -0
  139. data/lib/xbim_aim/models/o_data_list_response_of_spare.rb +247 -0
  140. data/lib/xbim_aim/models/o_data_list_response_of_system_item.rb +247 -0
  141. data/lib/xbim_aim/models/o_data_list_response_of_zone.rb +247 -0
  142. data/lib/xbim_aim/models/o_data_response_of_boolean.rb +227 -0
  143. data/lib/xbim_aim/models/quota_status.rb +300 -0
  144. data/lib/xbim_aim/models/related_entity.rb +432 -0
  145. data/lib/xbim_aim/models/resource.rb +443 -0
  146. data/lib/xbim_aim/models/resource_info.rb +308 -0
  147. data/lib/xbim_aim/models/role.rb +331 -0
  148. data/lib/xbim_aim/models/role_member.rb +279 -0
  149. data/lib/xbim_aim/models/row.rb +229 -0
  150. data/lib/xbim_aim/models/schedule.rb +258 -0
  151. data/lib/xbim_aim/models/site.rb +432 -0
  152. data/lib/xbim_aim/models/space.rb +491 -0
  153. data/lib/xbim_aim/models/space_create.rb +283 -0
  154. data/lib/xbim_aim/models/space_edit.rb +248 -0
  155. data/lib/xbim_aim/models/space_info.rb +326 -0
  156. data/lib/xbim_aim/models/spare.rb +450 -0
  157. data/lib/xbim_aim/models/spare_create.rb +283 -0
  158. data/lib/xbim_aim/models/spare_edit.rb +248 -0
  159. data/lib/xbim_aim/models/spare_info.rb +308 -0
  160. data/lib/xbim_aim/models/system_info.rb +319 -0
  161. data/lib/xbim_aim/models/system_item.rb +454 -0
  162. data/lib/xbim_aim/models/user_permissions.rb +275 -0
  163. data/lib/xbim_aim/models/value_container.rb +308 -0
  164. data/lib/xbim_aim/models/zone.rb +454 -0
  165. data/lib/xbim_aim/models/zone_info.rb +308 -0
  166. data/lib/xbim_aim/version.rb +15 -0
  167. data/lib/xbim_aim.rb +197 -0
  168. data/spec/api/admin_api_spec.rb +95 -0
  169. data/spec/api/applications_api_spec.rb +71 -0
  170. data/spec/api/assemblies_api_spec.rb +160 -0
  171. data/spec/api/assets_api_spec.rb +203 -0
  172. data/spec/api/attributes_api_spec.rb +177 -0
  173. data/spec/api/component_types_api_spec.rb +160 -0
  174. data/spec/api/components_api_spec.rb +184 -0
  175. data/spec/api/contacts_api_spec.rb +160 -0
  176. data/spec/api/diagnostics_api_spec.rb +54 -0
  177. data/spec/api/document_files_api_spec.rb +69 -0
  178. data/spec/api/documents_api_spec.rb +160 -0
  179. data/spec/api/entities_api_spec.rb +203 -0
  180. data/spec/api/facilities_api_spec.rb +160 -0
  181. data/spec/api/issues_api_spec.rb +160 -0
  182. data/spec/api/jobs_api_spec.rb +160 -0
  183. data/spec/api/levels_api_spec.rb +160 -0
  184. data/spec/api/logs_api_spec.rb +47 -0
  185. data/spec/api/model_files_api_spec.rb +71 -0
  186. data/spec/api/model_mapping_api_spec.rb +71 -0
  187. data/spec/api/models_api_spec.rb +273 -0
  188. data/spec/api/resources_api_spec.rb +160 -0
  189. data/spec/api/schedules_api_spec.rb +126 -0
  190. data/spec/api/sites_api_spec.rb +160 -0
  191. data/spec/api/spaces_api_spec.rb +184 -0
  192. data/spec/api/spares_api_spec.rb +160 -0
  193. data/spec/api/stats_api_spec.rb +61 -0
  194. data/spec/api/systems_api_spec.rb +160 -0
  195. data/spec/api/thumbnails_api_spec.rb +63 -0
  196. data/spec/api/wexbim_api_spec.rb +175 -0
  197. data/spec/api/zones_api_spec.rb +160 -0
  198. data/spec/api_client_spec.rb +226 -0
  199. data/spec/configuration_spec.rb +42 -0
  200. data/spec/models/application_spec.rb +70 -0
  201. data/spec/models/assembly_diagnostics_spec.rb +88 -0
  202. data/spec/models/assembly_info_spec.rb +94 -0
  203. data/spec/models/assembly_item_spec.rb +178 -0
  204. data/spec/models/asset_create_spec.rb +44 -0
  205. data/spec/models/asset_edit_spec.rb +44 -0
  206. data/spec/models/asset_segment_spec.rb +88 -0
  207. data/spec/models/asset_spec.rb +92 -0
  208. data/spec/models/attribute_definition_create_spec.rb +78 -0
  209. data/spec/models/attribute_definition_edit_spec.rb +62 -0
  210. data/spec/models/attribute_definition_entity_spec.rb +126 -0
  211. data/spec/models/attribute_definition_spec.rb +102 -0
  212. data/spec/models/attribute_value_entity_spec.rb +70 -0
  213. data/spec/models/attribute_value_spec.rb +92 -0
  214. data/spec/models/cell_spec.rb +46 -0
  215. data/spec/models/classification_node_spec.rb +58 -0
  216. data/spec/models/column_definition_spec.rb +68 -0
  217. data/spec/models/complex_value_base_spec.rb +44 -0
  218. data/spec/models/component_create_spec.rb +70 -0
  219. data/spec/models/component_edit_spec.rb +52 -0
  220. data/spec/models/component_info_spec.rb +106 -0
  221. data/spec/models/component_spec.rb +226 -0
  222. data/spec/models/component_type_info_spec.rb +94 -0
  223. data/spec/models/component_type_spec.rb +202 -0
  224. data/spec/models/contact_entity_spec.rb +92 -0
  225. data/spec/models/contact_info_spec.rb +94 -0
  226. data/spec/models/contact_spec.rb +172 -0
  227. data/spec/models/db_update_spec.rb +40 -0
  228. data/spec/models/document_create_spec.rb +106 -0
  229. data/spec/models/document_edit_spec.rb +88 -0
  230. data/spec/models/document_info_spec.rb +94 -0
  231. data/spec/models/document_spec.rb +160 -0
  232. data/spec/models/entity_base_spec.rb +94 -0
  233. data/spec/models/entity_contact_spec.rb +92 -0
  234. data/spec/models/entity_create_spec.rb +64 -0
  235. data/spec/models/entity_edit_spec.rb +46 -0
  236. data/spec/models/entity_mapping_info_spec.rb +88 -0
  237. data/spec/models/entity_match_descriptor_spec.rb +52 -0
  238. data/spec/models/entity_match_info_spec.rb +46 -0
  239. data/spec/models/entity_ref_spec.rb +76 -0
  240. data/spec/models/entity_spec.rb +160 -0
  241. data/spec/models/facility_info_spec.rb +94 -0
  242. data/spec/models/facility_spec.rb +166 -0
  243. data/spec/models/file_upload_result_spec.rb +82 -0
  244. data/spec/models/footprint_spec.rb +58 -0
  245. data/spec/models/i_metered_resource_spec.rb +58 -0
  246. data/spec/models/ifc_type_spec.rb +52 -0
  247. data/spec/models/inline_object1_spec.rb +56 -0
  248. data/spec/models/inline_object2_spec.rb +34 -0
  249. data/spec/models/inline_object3_spec.rb +34 -0
  250. data/spec/models/inline_object4_spec.rb +56 -0
  251. data/spec/models/inline_object5_spec.rb +56 -0
  252. data/spec/models/inline_object_spec.rb +56 -0
  253. data/spec/models/issue_info_spec.rb +94 -0
  254. data/spec/models/issue_spec.rb +172 -0
  255. data/spec/models/job_create_spec.rb +70 -0
  256. data/spec/models/job_edit_spec.rb +52 -0
  257. data/spec/models/job_info_spec.rb +94 -0
  258. data/spec/models/job_spec.rb +196 -0
  259. data/spec/models/level_create_spec.rb +64 -0
  260. data/spec/models/level_edit_spec.rb +46 -0
  261. data/spec/models/level_info_spec.rb +94 -0
  262. data/spec/models/level_spec.rb +184 -0
  263. data/spec/models/mapping_message_info_spec.rb +76 -0
  264. data/spec/models/mapping_properties_spec.rb +40 -0
  265. data/spec/models/member_permission_spec.rb +66 -0
  266. data/spec/models/member_role_spec.rb +82 -0
  267. data/spec/models/model_create_spec.rb +68 -0
  268. data/spec/models/model_edit_spec.rb +56 -0
  269. data/spec/models/model_info_spec.rb +142 -0
  270. data/spec/models/model_mapping_report_spec.rb +118 -0
  271. data/spec/models/model_mapping_spec.rb +124 -0
  272. data/spec/models/model_spec.rb +260 -0
  273. data/spec/models/o_data_list_response_of_application_spec.rb +52 -0
  274. data/spec/models/o_data_list_response_of_assembly_diagnostics_spec.rb +52 -0
  275. data/spec/models/o_data_list_response_of_assembly_item_spec.rb +52 -0
  276. data/spec/models/o_data_list_response_of_asset_spec.rb +52 -0
  277. data/spec/models/o_data_list_response_of_attribute_definition_entity_spec.rb +52 -0
  278. data/spec/models/o_data_list_response_of_attribute_definition_spec.rb +52 -0
  279. data/spec/models/o_data_list_response_of_attribute_value_spec.rb +52 -0
  280. data/spec/models/o_data_list_response_of_complex_value_base_spec.rb +52 -0
  281. data/spec/models/o_data_list_response_of_component_spec.rb +52 -0
  282. data/spec/models/o_data_list_response_of_component_type_spec.rb +52 -0
  283. data/spec/models/o_data_list_response_of_contact_spec.rb +52 -0
  284. data/spec/models/o_data_list_response_of_document_spec.rb +52 -0
  285. data/spec/models/o_data_list_response_of_entity_ref_spec.rb +52 -0
  286. data/spec/models/o_data_list_response_of_entity_spec.rb +52 -0
  287. data/spec/models/o_data_list_response_of_facility_spec.rb +52 -0
  288. data/spec/models/o_data_list_response_of_issue_spec.rb +52 -0
  289. data/spec/models/o_data_list_response_of_job_spec.rb +52 -0
  290. data/spec/models/o_data_list_response_of_level_spec.rb +52 -0
  291. data/spec/models/o_data_list_response_of_member_permission_spec.rb +52 -0
  292. data/spec/models/o_data_list_response_of_model_mapping_report_spec.rb +52 -0
  293. data/spec/models/o_data_list_response_of_model_mapping_spec.rb +52 -0
  294. data/spec/models/o_data_list_response_of_model_spec.rb +52 -0
  295. data/spec/models/o_data_list_response_of_resource_spec.rb +52 -0
  296. data/spec/models/o_data_list_response_of_role_spec.rb +52 -0
  297. data/spec/models/o_data_list_response_of_row_spec.rb +52 -0
  298. data/spec/models/o_data_list_response_of_schedule_spec.rb +52 -0
  299. data/spec/models/o_data_list_response_of_site_spec.rb +52 -0
  300. data/spec/models/o_data_list_response_of_space_spec.rb +52 -0
  301. data/spec/models/o_data_list_response_of_spare_spec.rb +52 -0
  302. data/spec/models/o_data_list_response_of_system_item_spec.rb +52 -0
  303. data/spec/models/o_data_list_response_of_zone_spec.rb +52 -0
  304. data/spec/models/o_data_response_of_boolean_spec.rb +40 -0
  305. data/spec/models/quota_status_spec.rb +66 -0
  306. data/spec/models/related_entity_spec.rb +166 -0
  307. data/spec/models/resource_info_spec.rb +94 -0
  308. data/spec/models/resource_spec.rb +172 -0
  309. data/spec/models/role_member_spec.rb +56 -0
  310. data/spec/models/role_spec.rb +88 -0
  311. data/spec/models/row_spec.rb +40 -0
  312. data/spec/models/schedule_spec.rb +58 -0
  313. data/spec/models/site_spec.rb +166 -0
  314. data/spec/models/space_create_spec.rb +70 -0
  315. data/spec/models/space_edit_spec.rb +52 -0
  316. data/spec/models/space_info_spec.rb +106 -0
  317. data/spec/models/space_spec.rb +202 -0
  318. data/spec/models/spare_create_spec.rb +70 -0
  319. data/spec/models/spare_edit_spec.rb +52 -0
  320. data/spec/models/spare_info_spec.rb +94 -0
  321. data/spec/models/spare_spec.rb +178 -0
  322. data/spec/models/system_info_spec.rb +100 -0
  323. data/spec/models/system_item_spec.rb +178 -0
  324. data/spec/models/user_permissions_spec.rb +56 -0
  325. data/spec/models/value_container_spec.rb +78 -0
  326. data/spec/models/zone_info_spec.rb +94 -0
  327. data/spec/models/zone_spec.rb +178 -0
  328. data/spec/spec_helper.rb +111 -0
  329. data/xbim_aim-1.0.0.gem +0 -0
  330. data/xbim_aim.gemspec +38 -0
  331. metadata +413 -0
@@ -0,0 +1,904 @@
1
+ =begin
2
+ #XBIM Flex API v2
3
+
4
+ #This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: info@xbim.net
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module XbimAim
16
+ class EntitiesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Adds a new document to a model entity
23
+ # <span style='font-size: 17px;'>Summary:</span>Adds a new document to a model entity.<br/>Return Type: <b>Document</b><br/><br/>
24
+ # @param asset_model_id [Integer] The model Id
25
+ # @param entity_id [Integer] The unique identifier for the target entity (Entity Label)
26
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
27
+ # @param region [String] The data center region the data resides in
28
+ # @param document [DocumentCreate] A document to create
29
+ # @param [Hash] opts the optional parameters
30
+ # @return [Document]
31
+ def entities_add_document_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, document, opts = {})
32
+ data, _status_code, _headers = entities_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts)
33
+ data
34
+ end
35
+
36
+ # Adds a new document to a model entity
37
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds a new document to a model entity.&lt;br/&gt;Return Type: &lt;b&gt;Document&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
38
+ # @param asset_model_id [Integer] The model Id
39
+ # @param entity_id [Integer] The unique identifier for the target entity (Entity Label)
40
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
41
+ # @param region [String] The data center region the data resides in
42
+ # @param document [DocumentCreate] A document to create
43
+ # @param [Hash] opts the optional parameters
44
+ # @return [Array<(Document, Integer, Hash)>] Document data, response status code and response headers
45
+ def entities_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid ...'
48
+ end
49
+ # verify the required parameter 'asset_model_id' is set
50
+ if @api_client.config.client_side_validation && asset_model_id.nil?
51
+ fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid"
52
+ end
53
+ # verify the required parameter 'entity_id' is set
54
+ if @api_client.config.client_side_validation && entity_id.nil?
55
+ fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid"
56
+ end
57
+ # verify the required parameter 'tenant_id' is set
58
+ if @api_client.config.client_side_validation && tenant_id.nil?
59
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid"
60
+ end
61
+ # verify the required parameter 'region' is set
62
+ if @api_client.config.client_side_validation && region.nil?
63
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid"
64
+ end
65
+ # verify enum value
66
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
67
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
68
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
69
+ end
70
+ # verify the required parameter 'document' is set
71
+ if @api_client.config.client_side_validation && document.nil?
72
+ fail ArgumentError, "Missing the required parameter 'document' when calling EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid"
73
+ end
74
+ # resource path
75
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
76
+
77
+ # query parameters
78
+ query_params = opts[:query_params] || {}
79
+
80
+ # header parameters
81
+ header_params = opts[:header_params] || {}
82
+ # HTTP header 'Accept' (if needed)
83
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
84
+ # HTTP header 'Content-Type'
85
+ content_type = @api_client.select_header_content_type(['application/json'])
86
+ if !content_type.nil?
87
+ header_params['Content-Type'] = content_type
88
+ end
89
+
90
+ # form parameters
91
+ form_params = opts[:form_params] || {}
92
+
93
+ # http body (model)
94
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(document)
95
+
96
+ # return_type
97
+ return_type = opts[:debug_return_type] || 'Document'
98
+
99
+ # auth_names
100
+ auth_names = opts[:debug_auth_names] || ['oauth2']
101
+
102
+ new_options = opts.merge(
103
+ :operation => :"EntitiesApi.entities_add_document_by_assetmodelid_and_entityid_and_tenantid",
104
+ :header_params => header_params,
105
+ :query_params => query_params,
106
+ :form_params => form_params,
107
+ :body => post_body,
108
+ :auth_names => auth_names,
109
+ :return_type => return_type
110
+ )
111
+
112
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
113
+ if @api_client.config.debugging
114
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_add_document_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
115
+ end
116
+ return data, status_code, headers
117
+ end
118
+
119
+ # Get Entities as of by date and tenantid
120
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ODataListResponseOfEntity</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
121
+ # @param date [Time]
122
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
123
+ # @param region [String] The data center region the data resides in
124
+ # @param [Hash] opts the optional parameters
125
+ # @option opts [String] :expand Expands related entities inline.
126
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
127
+ # @option opts [String] :select Selects which properties to include in the response.
128
+ # @option opts [String] :orderby Sorts the results.
129
+ # @option opts [Integer] :top Returns only the first n results.
130
+ # @option opts [Integer] :skip Skips the first n results.
131
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
132
+ # @return [ODataListResponseOfEntity]
133
+ def entities_as_of_by_date_and_tenantid(date, tenant_id, region, opts = {})
134
+ data, _status_code, _headers = entities_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts)
135
+ data
136
+ end
137
+
138
+ # Get Entities as of by date and tenantid
139
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataListResponseOfEntity&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
140
+ # @param date [Time]
141
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
142
+ # @param region [String] The data center region the data resides in
143
+ # @param [Hash] opts the optional parameters
144
+ # @option opts [String] :expand Expands related entities inline.
145
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
146
+ # @option opts [String] :select Selects which properties to include in the response.
147
+ # @option opts [String] :orderby Sorts the results.
148
+ # @option opts [Integer] :top Returns only the first n results.
149
+ # @option opts [Integer] :skip Skips the first n results.
150
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
151
+ # @return [Array<(ODataListResponseOfEntity, Integer, Hash)>] ODataListResponseOfEntity data, response status code and response headers
152
+ def entities_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts = {})
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_as_of_by_date_and_tenantid ...'
155
+ end
156
+ # verify the required parameter 'date' is set
157
+ if @api_client.config.client_side_validation && date.nil?
158
+ fail ArgumentError, "Missing the required parameter 'date' when calling EntitiesApi.entities_as_of_by_date_and_tenantid"
159
+ end
160
+ # verify the required parameter 'tenant_id' is set
161
+ if @api_client.config.client_side_validation && tenant_id.nil?
162
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_as_of_by_date_and_tenantid"
163
+ end
164
+ # verify the required parameter 'region' is set
165
+ if @api_client.config.client_side_validation && region.nil?
166
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_as_of_by_date_and_tenantid"
167
+ end
168
+ # verify enum value
169
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
170
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
171
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
172
+ end
173
+ # resource path
174
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities/AsOf(date={date})'.sub('{' + 'date' + '}', CGI.escape(date.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
175
+
176
+ # query parameters
177
+ query_params = opts[:query_params] || {}
178
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
179
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
180
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
181
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
182
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
183
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
184
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
185
+
186
+ # header parameters
187
+ header_params = opts[:header_params] || {}
188
+ # HTTP header 'Accept' (if needed)
189
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
190
+
191
+ # form parameters
192
+ form_params = opts[:form_params] || {}
193
+
194
+ # http body (model)
195
+ post_body = opts[:debug_body]
196
+
197
+ # return_type
198
+ return_type = opts[:debug_return_type] || 'ODataListResponseOfEntity'
199
+
200
+ # auth_names
201
+ auth_names = opts[:debug_auth_names] || ['oauth2']
202
+
203
+ new_options = opts.merge(
204
+ :operation => :"EntitiesApi.entities_as_of_by_date_and_tenantid",
205
+ :header_params => header_params,
206
+ :query_params => query_params,
207
+ :form_params => form_params,
208
+ :body => post_body,
209
+ :auth_names => auth_names,
210
+ :return_type => return_type
211
+ )
212
+
213
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
214
+ if @api_client.config.debugging
215
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_as_of_by_date_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
216
+ end
217
+ return data, status_code, headers
218
+ end
219
+
220
+ # Query a set of Entities at a point in time
221
+ # <span style='font-size: 17px;'>Summary:</span>Query a set of Entities at a point in time.<br/>Service allows consumers to interogate the state of entities at any point in the history by specifying a date to view the results at<br /> Note that casting is not currently supported..<br/>Return Type: <b>ODataListResponseOfEntity</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
222
+ # @param date [Time] The Date to view the entites at
223
+ # @param entity_kind [String] The kind of entity to return
224
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
225
+ # @param region [String] The data center region the data resides in
226
+ # @param [Hash] opts the optional parameters
227
+ # @option opts [String] :expand Expands related entities inline.
228
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
229
+ # @option opts [String] :select Selects which properties to include in the response.
230
+ # @option opts [String] :orderby Sorts the results.
231
+ # @option opts [Integer] :top Returns only the first n results.
232
+ # @option opts [Integer] :skip Skips the first n results.
233
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
234
+ # @return [ODataListResponseOfEntity]
235
+ def entities_as_of_by_kind(date, entity_kind, tenant_id, region, opts = {})
236
+ data, _status_code, _headers = entities_as_of_by_kind_with_http_info(date, entity_kind, tenant_id, region, opts)
237
+ data
238
+ end
239
+
240
+ # Query a set of Entities at a point in time
241
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Query a set of Entities at a point in time.&lt;br/&gt;Service allows consumers to interogate the state of entities at any point in the history by specifying a date to view the results at&lt;br /&gt; Note that casting is not currently supported..&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfEntity&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
242
+ # @param date [Time] The Date to view the entites at
243
+ # @param entity_kind [String] The kind of entity to return
244
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
245
+ # @param region [String] The data center region the data resides in
246
+ # @param [Hash] opts the optional parameters
247
+ # @option opts [String] :expand Expands related entities inline.
248
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
249
+ # @option opts [String] :select Selects which properties to include in the response.
250
+ # @option opts [String] :orderby Sorts the results.
251
+ # @option opts [Integer] :top Returns only the first n results.
252
+ # @option opts [Integer] :skip Skips the first n results.
253
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
254
+ # @return [Array<(ODataListResponseOfEntity, Integer, Hash)>] ODataListResponseOfEntity data, response status code and response headers
255
+ def entities_as_of_by_kind_with_http_info(date, entity_kind, tenant_id, region, opts = {})
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_as_of_by_kind ...'
258
+ end
259
+ # verify the required parameter 'date' is set
260
+ if @api_client.config.client_side_validation && date.nil?
261
+ fail ArgumentError, "Missing the required parameter 'date' when calling EntitiesApi.entities_as_of_by_kind"
262
+ end
263
+ # verify the required parameter 'entity_kind' is set
264
+ if @api_client.config.client_side_validation && entity_kind.nil?
265
+ fail ArgumentError, "Missing the required parameter 'entity_kind' when calling EntitiesApi.entities_as_of_by_kind"
266
+ end
267
+ # verify enum value
268
+ allowable_values = ["Entity", "Facility", "Component", "ComponentType", "Assembly", "Level", "System", "Resource", "Job", "Zone", "Issue", "Spare", "Document", "Contact", "Space", "Site"]
269
+ if @api_client.config.client_side_validation && !allowable_values.include?(entity_kind)
270
+ fail ArgumentError, "invalid value for \"entity_kind\", must be one of #{allowable_values}"
271
+ end
272
+ # verify the required parameter 'tenant_id' is set
273
+ if @api_client.config.client_side_validation && tenant_id.nil?
274
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_as_of_by_kind"
275
+ end
276
+ # verify the required parameter 'region' is set
277
+ if @api_client.config.client_side_validation && region.nil?
278
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_as_of_by_kind"
279
+ end
280
+ # verify enum value
281
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
282
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
283
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
284
+ end
285
+ # resource path
286
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities/AsOf(date={date},entityKind={entityKind})'.sub('{' + 'date' + '}', CGI.escape(date.to_s)).sub('{' + 'entityKind' + '}', CGI.escape(entity_kind.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
287
+
288
+ # query parameters
289
+ query_params = opts[:query_params] || {}
290
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
291
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
292
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
293
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
294
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
295
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
296
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
297
+
298
+ # header parameters
299
+ header_params = opts[:header_params] || {}
300
+ # HTTP header 'Accept' (if needed)
301
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
302
+
303
+ # form parameters
304
+ form_params = opts[:form_params] || {}
305
+
306
+ # http body (model)
307
+ post_body = opts[:debug_body]
308
+
309
+ # return_type
310
+ return_type = opts[:debug_return_type] || 'ODataListResponseOfEntity'
311
+
312
+ # auth_names
313
+ auth_names = opts[:debug_auth_names] || ['oauth2']
314
+
315
+ new_options = opts.merge(
316
+ :operation => :"EntitiesApi.entities_as_of_by_kind",
317
+ :header_params => header_params,
318
+ :query_params => query_params,
319
+ :form_params => form_params,
320
+ :body => post_body,
321
+ :auth_names => auth_names,
322
+ :return_type => return_type
323
+ )
324
+
325
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
326
+ if @api_client.config.debugging
327
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_as_of_by_kind\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
328
+ end
329
+ return data, status_code, headers
330
+ end
331
+
332
+ # Gets the Properties available on this Model
333
+ # <span style='font-size: 17px;'>Summary:</span>Gets the Properties available on this Model.<br/>Return Type: <b>ODataListResponseOfAttributeDefinition</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
334
+ # @param asset_id [Integer] The unique key for the asset
335
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
336
+ # @param region [String] The data center region the data resides in
337
+ # @param [Hash] opts the optional parameters
338
+ # @option opts [String] :expand Expands related entities inline.
339
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
340
+ # @option opts [String] :select Selects which properties to include in the response.
341
+ # @option opts [String] :orderby Sorts the results.
342
+ # @option opts [Integer] :top Returns only the first n results.
343
+ # @option opts [Integer] :skip Skips the first n results.
344
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
345
+ # @return [ODataListResponseOfAttributeDefinition]
346
+ def entities_get_available_properties_by_assetid_and_tenantid(asset_id, tenant_id, region, opts = {})
347
+ data, _status_code, _headers = entities_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts)
348
+ data
349
+ end
350
+
351
+ # Gets the Properties available on this Model
352
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the Properties available on this Model.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfAttributeDefinition&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
353
+ # @param asset_id [Integer] The unique key for the asset
354
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
355
+ # @param region [String] The data center region the data resides in
356
+ # @param [Hash] opts the optional parameters
357
+ # @option opts [String] :expand Expands related entities inline.
358
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
359
+ # @option opts [String] :select Selects which properties to include in the response.
360
+ # @option opts [String] :orderby Sorts the results.
361
+ # @option opts [Integer] :top Returns only the first n results.
362
+ # @option opts [Integer] :skip Skips the first n results.
363
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
364
+ # @return [Array<(ODataListResponseOfAttributeDefinition, Integer, Hash)>] ODataListResponseOfAttributeDefinition data, response status code and response headers
365
+ def entities_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts = {})
366
+ if @api_client.config.debugging
367
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_get_available_properties_by_assetid_and_tenantid ...'
368
+ end
369
+ # verify the required parameter 'asset_id' is set
370
+ if @api_client.config.client_side_validation && asset_id.nil?
371
+ fail ArgumentError, "Missing the required parameter 'asset_id' when calling EntitiesApi.entities_get_available_properties_by_assetid_and_tenantid"
372
+ end
373
+ # verify the required parameter 'tenant_id' is set
374
+ if @api_client.config.client_side_validation && tenant_id.nil?
375
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_get_available_properties_by_assetid_and_tenantid"
376
+ end
377
+ # verify the required parameter 'region' is set
378
+ if @api_client.config.client_side_validation && region.nil?
379
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_get_available_properties_by_assetid_and_tenantid"
380
+ end
381
+ # verify enum value
382
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
383
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
384
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
385
+ end
386
+ # resource path
387
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities/GetAvailableProperties(assetId={assetId})'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
388
+
389
+ # query parameters
390
+ query_params = opts[:query_params] || {}
391
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
392
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
393
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
394
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
395
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
396
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
397
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
398
+
399
+ # header parameters
400
+ header_params = opts[:header_params] || {}
401
+ # HTTP header 'Accept' (if needed)
402
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
403
+
404
+ # form parameters
405
+ form_params = opts[:form_params] || {}
406
+
407
+ # http body (model)
408
+ post_body = opts[:debug_body]
409
+
410
+ # return_type
411
+ return_type = opts[:debug_return_type] || 'ODataListResponseOfAttributeDefinition'
412
+
413
+ # auth_names
414
+ auth_names = opts[:debug_auth_names] || ['oauth2']
415
+
416
+ new_options = opts.merge(
417
+ :operation => :"EntitiesApi.entities_get_available_properties_by_assetid_and_tenantid",
418
+ :header_params => header_params,
419
+ :query_params => query_params,
420
+ :form_params => form_params,
421
+ :body => post_body,
422
+ :auth_names => auth_names,
423
+ :return_type => return_type
424
+ )
425
+
426
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
427
+ if @api_client.config.debugging
428
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_get_available_properties_by_assetid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
429
+ end
430
+ return data, status_code, headers
431
+ end
432
+
433
+ # Returns the EntitySet Entities
434
+ # <span style='font-size: 17px;'>Summary:</span>Returns the EntitySet Entities.<br/>Return Type: <b>ODataListResponseOfEntity</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
435
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
436
+ # @param region [String] The data center region the data resides in
437
+ # @param [Hash] opts the optional parameters
438
+ # @option opts [String] :expand Expands related entities inline.
439
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
440
+ # @option opts [String] :select Selects which properties to include in the response.
441
+ # @option opts [String] :orderby Sorts the results.
442
+ # @option opts [Integer] :top Returns only the first n results.
443
+ # @option opts [Integer] :skip Skips the first n results.
444
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
445
+ # @return [ODataListResponseOfEntity]
446
+ def entities_get_by_tenantid(tenant_id, region, opts = {})
447
+ data, _status_code, _headers = entities_get_by_tenantid_with_http_info(tenant_id, region, opts)
448
+ data
449
+ end
450
+
451
+ # Returns the EntitySet Entities
452
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Entities.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfEntity&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
453
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
454
+ # @param region [String] The data center region the data resides in
455
+ # @param [Hash] opts the optional parameters
456
+ # @option opts [String] :expand Expands related entities inline.
457
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
458
+ # @option opts [String] :select Selects which properties to include in the response.
459
+ # @option opts [String] :orderby Sorts the results.
460
+ # @option opts [Integer] :top Returns only the first n results.
461
+ # @option opts [Integer] :skip Skips the first n results.
462
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
463
+ # @return [Array<(ODataListResponseOfEntity, Integer, Hash)>] ODataListResponseOfEntity data, response status code and response headers
464
+ def entities_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
465
+ if @api_client.config.debugging
466
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_get_by_tenantid ...'
467
+ end
468
+ # verify the required parameter 'tenant_id' is set
469
+ if @api_client.config.client_side_validation && tenant_id.nil?
470
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_get_by_tenantid"
471
+ end
472
+ # verify the required parameter 'region' is set
473
+ if @api_client.config.client_side_validation && region.nil?
474
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_get_by_tenantid"
475
+ end
476
+ # verify enum value
477
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
478
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
479
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
480
+ end
481
+ # resource path
482
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
483
+
484
+ # query parameters
485
+ query_params = opts[:query_params] || {}
486
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
487
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
488
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
489
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
490
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
491
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
492
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
493
+
494
+ # header parameters
495
+ header_params = opts[:header_params] || {}
496
+ # HTTP header 'Accept' (if needed)
497
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
498
+
499
+ # form parameters
500
+ form_params = opts[:form_params] || {}
501
+
502
+ # http body (model)
503
+ post_body = opts[:debug_body]
504
+
505
+ # return_type
506
+ return_type = opts[:debug_return_type] || 'ODataListResponseOfEntity'
507
+
508
+ # auth_names
509
+ auth_names = opts[:debug_auth_names] || ['oauth2']
510
+
511
+ new_options = opts.merge(
512
+ :operation => :"EntitiesApi.entities_get_by_tenantid",
513
+ :header_params => header_params,
514
+ :query_params => query_params,
515
+ :form_params => form_params,
516
+ :body => post_body,
517
+ :auth_names => auth_names,
518
+ :return_type => return_type
519
+ )
520
+
521
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
522
+ if @api_client.config.debugging
523
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_get_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
524
+ end
525
+ return data, status_code, headers
526
+ end
527
+
528
+ # Get Entities single entity by assetmodelid, entityid and tenantid
529
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Entity</b><br/><br/>
530
+ # @param asset_model_id [Integer]
531
+ # @param entity_id [Integer]
532
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
533
+ # @param region [String] The data center region the data resides in
534
+ # @param [Hash] opts the optional parameters
535
+ # @option opts [String] :expand Expands related entities inline.
536
+ # @option opts [String] :select Selects which properties to include in the response.
537
+ # @return [Entity]
538
+ def entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {})
539
+ data, _status_code, _headers = entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts)
540
+ data
541
+ end
542
+
543
+ # Get Entities single entity by assetmodelid, entityid and tenantid
544
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
545
+ # @param asset_model_id [Integer]
546
+ # @param entity_id [Integer]
547
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
548
+ # @param region [String] The data center region the data resides in
549
+ # @param [Hash] opts the optional parameters
550
+ # @option opts [String] :expand Expands related entities inline.
551
+ # @option opts [String] :select Selects which properties to include in the response.
552
+ # @return [Array<(Entity, Integer, Hash)>] Entity data, response status code and response headers
553
+ def entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts = {})
554
+ if @api_client.config.debugging
555
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid ...'
556
+ end
557
+ # verify the required parameter 'asset_model_id' is set
558
+ if @api_client.config.client_side_validation && asset_model_id.nil?
559
+ fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
560
+ end
561
+ # verify the required parameter 'entity_id' is set
562
+ if @api_client.config.client_side_validation && entity_id.nil?
563
+ fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
564
+ end
565
+ # verify the required parameter 'tenant_id' is set
566
+ if @api_client.config.client_side_validation && tenant_id.nil?
567
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
568
+ end
569
+ # verify the required parameter 'region' is set
570
+ if @api_client.config.client_side_validation && region.nil?
571
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
572
+ end
573
+ # verify enum value
574
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
575
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
576
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
577
+ end
578
+ # resource path
579
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities(AssetModelId={assetModelId}, EntityId={entityId})'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
580
+
581
+ # query parameters
582
+ query_params = opts[:query_params] || {}
583
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
584
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
585
+
586
+ # header parameters
587
+ header_params = opts[:header_params] || {}
588
+ # HTTP header 'Accept' (if needed)
589
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
590
+
591
+ # form parameters
592
+ form_params = opts[:form_params] || {}
593
+
594
+ # http body (model)
595
+ post_body = opts[:debug_body]
596
+
597
+ # return_type
598
+ return_type = opts[:debug_return_type] || 'Entity'
599
+
600
+ # auth_names
601
+ auth_names = opts[:debug_auth_names] || ['oauth2']
602
+
603
+ new_options = opts.merge(
604
+ :operation => :"EntitiesApi.entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid",
605
+ :header_params => header_params,
606
+ :query_params => query_params,
607
+ :form_params => form_params,
608
+ :body => post_body,
609
+ :auth_names => auth_names,
610
+ :return_type => return_type
611
+ )
612
+
613
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
614
+ if @api_client.config.debugging
615
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
616
+ end
617
+ return data, status_code, headers
618
+ end
619
+
620
+ # Provides the xbim flex identities for a set of provided IfcGuids
621
+ # <span style='font-size: 17px;'>Summary:</span>Provides the xbim flex identities for a set of provided IfcGuids.<br/>Typically used to map from external Guids in BCF files to the best internal candidates in Flex.<br/>Return Type: <b>ODataListResponseOfEntityRef</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
622
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
623
+ # @param region [String] The data center region the data resides in
624
+ # @param [Hash] opts the optional parameters
625
+ # @option opts [String] :expand Expands related entities inline.
626
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
627
+ # @option opts [String] :select Selects which properties to include in the response.
628
+ # @option opts [String] :orderby Sorts the results.
629
+ # @option opts [Integer] :top Returns only the first n results.
630
+ # @option opts [Integer] :skip Skips the first n results.
631
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
632
+ # @option opts [InlineObject2] :parameters
633
+ # @return [ODataListResponseOfEntityRef]
634
+ def entities_lookup_by_tenantid(tenant_id, region, opts = {})
635
+ data, _status_code, _headers = entities_lookup_by_tenantid_with_http_info(tenant_id, region, opts)
636
+ data
637
+ end
638
+
639
+ # Provides the xbim flex identities for a set of provided IfcGuids
640
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Provides the xbim flex identities for a set of provided IfcGuids.&lt;br/&gt;Typically used to map from external Guids in BCF files to the best internal candidates in Flex.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfEntityRef&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
641
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
642
+ # @param region [String] The data center region the data resides in
643
+ # @param [Hash] opts the optional parameters
644
+ # @option opts [String] :expand Expands related entities inline.
645
+ # @option opts [String] :filter Filters the results, based on a Boolean condition.
646
+ # @option opts [String] :select Selects which properties to include in the response.
647
+ # @option opts [String] :orderby Sorts the results.
648
+ # @option opts [Integer] :top Returns only the first n results.
649
+ # @option opts [Integer] :skip Skips the first n results.
650
+ # @option opts [Boolean] :count Includes a count of the matching results in the response.
651
+ # @option opts [InlineObject2] :parameters
652
+ # @return [Array<(ODataListResponseOfEntityRef, Integer, Hash)>] ODataListResponseOfEntityRef data, response status code and response headers
653
+ def entities_lookup_by_tenantid_with_http_info(tenant_id, region, opts = {})
654
+ if @api_client.config.debugging
655
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_lookup_by_tenantid ...'
656
+ end
657
+ # verify the required parameter 'tenant_id' is set
658
+ if @api_client.config.client_side_validation && tenant_id.nil?
659
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_lookup_by_tenantid"
660
+ end
661
+ # verify the required parameter 'region' is set
662
+ if @api_client.config.client_side_validation && region.nil?
663
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_lookup_by_tenantid"
664
+ end
665
+ # verify enum value
666
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
667
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
668
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
669
+ end
670
+ # resource path
671
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities/Guids.Lookup'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
672
+
673
+ # query parameters
674
+ query_params = opts[:query_params] || {}
675
+ query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
676
+ query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
677
+ query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
678
+ query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
679
+ query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
680
+ query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
681
+ query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
682
+
683
+ # header parameters
684
+ header_params = opts[:header_params] || {}
685
+ # HTTP header 'Accept' (if needed)
686
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
687
+ # HTTP header 'Content-Type'
688
+ content_type = @api_client.select_header_content_type(['application/json'])
689
+ if !content_type.nil?
690
+ header_params['Content-Type'] = content_type
691
+ end
692
+
693
+ # form parameters
694
+ form_params = opts[:form_params] || {}
695
+
696
+ # http body (model)
697
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'parameters'])
698
+
699
+ # return_type
700
+ return_type = opts[:debug_return_type] || 'ODataListResponseOfEntityRef'
701
+
702
+ # auth_names
703
+ auth_names = opts[:debug_auth_names] || ['oauth2']
704
+
705
+ new_options = opts.merge(
706
+ :operation => :"EntitiesApi.entities_lookup_by_tenantid",
707
+ :header_params => header_params,
708
+ :query_params => query_params,
709
+ :form_params => form_params,
710
+ :body => post_body,
711
+ :auth_names => auth_names,
712
+ :return_type => return_type
713
+ )
714
+
715
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
716
+ if @api_client.config.debugging
717
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_lookup_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
718
+ end
719
+ return data, status_code, headers
720
+ end
721
+
722
+ # Patch Entities by assetmodelid, entityid and tenantid
723
+ # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Entity</b><br/><br/>
724
+ # @param asset_model_id [Integer]
725
+ # @param entity_id [Integer]
726
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
727
+ # @param region [String] The data center region the data resides in
728
+ # @param patch [EntityEdit]
729
+ # @param [Hash] opts the optional parameters
730
+ # @return [Entity]
731
+ def entities_patch_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
732
+ data, _status_code, _headers = entities_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts)
733
+ data
734
+ end
735
+
736
+ # Patch Entities by assetmodelid, entityid and tenantid
737
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
738
+ # @param asset_model_id [Integer]
739
+ # @param entity_id [Integer]
740
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
741
+ # @param region [String] The data center region the data resides in
742
+ # @param patch [EntityEdit]
743
+ # @param [Hash] opts the optional parameters
744
+ # @return [Array<(Entity, Integer, Hash)>] Entity data, response status code and response headers
745
+ def entities_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
746
+ if @api_client.config.debugging
747
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid ...'
748
+ end
749
+ # verify the required parameter 'asset_model_id' is set
750
+ if @api_client.config.client_side_validation && asset_model_id.nil?
751
+ fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid"
752
+ end
753
+ # verify the required parameter 'entity_id' is set
754
+ if @api_client.config.client_side_validation && entity_id.nil?
755
+ fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid"
756
+ end
757
+ # verify the required parameter 'tenant_id' is set
758
+ if @api_client.config.client_side_validation && tenant_id.nil?
759
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid"
760
+ end
761
+ # verify the required parameter 'region' is set
762
+ if @api_client.config.client_side_validation && region.nil?
763
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid"
764
+ end
765
+ # verify enum value
766
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
767
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
768
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
769
+ end
770
+ # verify the required parameter 'patch' is set
771
+ if @api_client.config.client_side_validation && patch.nil?
772
+ fail ArgumentError, "Missing the required parameter 'patch' when calling EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid"
773
+ end
774
+ # resource path
775
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities(AssetModelId={AssetModelId}, EntityId={EntityId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'EntityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
776
+
777
+ # query parameters
778
+ query_params = opts[:query_params] || {}
779
+
780
+ # header parameters
781
+ header_params = opts[:header_params] || {}
782
+ # HTTP header 'Accept' (if needed)
783
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
784
+ # HTTP header 'Content-Type'
785
+ content_type = @api_client.select_header_content_type(['application/json'])
786
+ if !content_type.nil?
787
+ header_params['Content-Type'] = content_type
788
+ end
789
+
790
+ # form parameters
791
+ form_params = opts[:form_params] || {}
792
+
793
+ # http body (model)
794
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch)
795
+
796
+ # return_type
797
+ return_type = opts[:debug_return_type] || 'Entity'
798
+
799
+ # auth_names
800
+ auth_names = opts[:debug_auth_names] || ['oauth2']
801
+
802
+ new_options = opts.merge(
803
+ :operation => :"EntitiesApi.entities_patch_by_assetmodelid_and_entityid_and_tenantid",
804
+ :header_params => header_params,
805
+ :query_params => query_params,
806
+ :form_params => form_params,
807
+ :body => post_body,
808
+ :auth_names => auth_names,
809
+ :return_type => return_type
810
+ )
811
+
812
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
813
+ if @api_client.config.debugging
814
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_patch_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
815
+ end
816
+ return data, status_code, headers
817
+ end
818
+
819
+ # Post a new entity to EntitySet Entities
820
+ # <span style='font-size: 17px;'>Summary:</span>Post a new entity to EntitySet Entities.<br/>Return Type: <b>Entity</b><br/><br/>
821
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
822
+ # @param region [String] The data center region the data resides in
823
+ # @param entity [EntityCreate] The entity to post
824
+ # @param [Hash] opts the optional parameters
825
+ # @return [Entity]
826
+ def entities_post_by_tenantid(tenant_id, region, entity, opts = {})
827
+ data, _status_code, _headers = entities_post_by_tenantid_with_http_info(tenant_id, region, entity, opts)
828
+ data
829
+ end
830
+
831
+ # Post a new entity to EntitySet Entities
832
+ # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Post a new entity to EntitySet Entities.&lt;br/&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
833
+ # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
834
+ # @param region [String] The data center region the data resides in
835
+ # @param entity [EntityCreate] The entity to post
836
+ # @param [Hash] opts the optional parameters
837
+ # @return [Array<(Entity, Integer, Hash)>] Entity data, response status code and response headers
838
+ def entities_post_by_tenantid_with_http_info(tenant_id, region, entity, opts = {})
839
+ if @api_client.config.debugging
840
+ @api_client.config.logger.debug 'Calling API: EntitiesApi.entities_post_by_tenantid ...'
841
+ end
842
+ # verify the required parameter 'tenant_id' is set
843
+ if @api_client.config.client_side_validation && tenant_id.nil?
844
+ fail ArgumentError, "Missing the required parameter 'tenant_id' when calling EntitiesApi.entities_post_by_tenantid"
845
+ end
846
+ # verify the required parameter 'region' is set
847
+ if @api_client.config.client_side_validation && region.nil?
848
+ fail ArgumentError, "Missing the required parameter 'region' when calling EntitiesApi.entities_post_by_tenantid"
849
+ end
850
+ # verify enum value
851
+ allowable_values = ["UK", "WestEurope", "Sandbox"]
852
+ if @api_client.config.client_side_validation && !allowable_values.include?(region)
853
+ fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
854
+ end
855
+ # verify the required parameter 'entity' is set
856
+ if @api_client.config.client_side_validation && entity.nil?
857
+ fail ArgumentError, "Missing the required parameter 'entity' when calling EntitiesApi.entities_post_by_tenantid"
858
+ end
859
+ # resource path
860
+ local_var_path = '/{region}/aim/2.0/{tenantId}/Entities'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
861
+
862
+ # query parameters
863
+ query_params = opts[:query_params] || {}
864
+
865
+ # header parameters
866
+ header_params = opts[:header_params] || {}
867
+ # HTTP header 'Accept' (if needed)
868
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
869
+ # HTTP header 'Content-Type'
870
+ content_type = @api_client.select_header_content_type(['application/json'])
871
+ if !content_type.nil?
872
+ header_params['Content-Type'] = content_type
873
+ end
874
+
875
+ # form parameters
876
+ form_params = opts[:form_params] || {}
877
+
878
+ # http body (model)
879
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(entity)
880
+
881
+ # return_type
882
+ return_type = opts[:debug_return_type] || 'Entity'
883
+
884
+ # auth_names
885
+ auth_names = opts[:debug_auth_names] || ['oauth2']
886
+
887
+ new_options = opts.merge(
888
+ :operation => :"EntitiesApi.entities_post_by_tenantid",
889
+ :header_params => header_params,
890
+ :query_params => query_params,
891
+ :form_params => form_params,
892
+ :body => post_body,
893
+ :auth_names => auth_names,
894
+ :return_type => return_type
895
+ )
896
+
897
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
898
+ if @api_client.config.debugging
899
+ @api_client.config.logger.debug "API called: EntitiesApi#entities_post_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
900
+ end
901
+ return data, status_code, headers
902
+ end
903
+ end
904
+ end