visier-platform-sdk 22222222.99201.2145__py3-none-any.whl → 22222222.99201.2174__py3-none-any.whl

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.

Potentially problematic release.


This version of visier-platform-sdk might be problematic. Click here for more details.

Files changed (813) hide show
  1. visier_platform_sdk/__init__.py +54 -20
  2. visier_platform_sdk/api/__init__.py +2 -0
  3. visier_platform_sdk/api/analytic_objects_v2_api.py +2229 -0
  4. visier_platform_sdk/api/basic_authentication_api.py +1 -1
  5. visier_platform_sdk/api/benchmarks_api.py +1 -1
  6. visier_platform_sdk/api/concepts_v2_api.py +19 -19
  7. visier_platform_sdk/api/consolidated_analytics_api.py +1 -1
  8. visier_platform_sdk/api/data_and_job_handling_api.py +1 -1
  9. visier_platform_sdk/api/data_intake_api.py +1 -1
  10. visier_platform_sdk/api/data_model_api.py +7 -299
  11. visier_platform_sdk/api/data_query_api.py +1 -1
  12. visier_platform_sdk/api/data_upload_api.py +1 -1
  13. visier_platform_sdk/api/data_version_export_api.py +1 -1
  14. visier_platform_sdk/api/dimensions_api.py +1 -1
  15. visier_platform_sdk/api/dimensions_v2_api.py +1 -1
  16. visier_platform_sdk/api/direct_data_intake_api.py +1 -1
  17. visier_platform_sdk/api/email_domains_api.py +1 -1
  18. visier_platform_sdk/api/encryption_keys_api.py +1 -1
  19. visier_platform_sdk/api/jobs_library_api.py +1 -1
  20. visier_platform_sdk/api/metrics_v2_api.py +2286 -0
  21. visier_platform_sdk/api/network_subnets_api.py +1 -1
  22. visier_platform_sdk/api/o_auth2_api.py +1 -1
  23. visier_platform_sdk/api/object_configuration_api.py +1 -1
  24. visier_platform_sdk/api/permissions_api.py +1 -1
  25. visier_platform_sdk/api/personalized_alerts_api.py +1 -1
  26. visier_platform_sdk/api/pgp_keys_api.py +1 -1
  27. visier_platform_sdk/api/plan_administration_api.py +48 -316
  28. visier_platform_sdk/api/plan_data_load_api.py +2 -2
  29. visier_platform_sdk/api/production_versions_api.py +1 -1
  30. visier_platform_sdk/api/profiles_api.py +1 -1
  31. visier_platform_sdk/api/projects_api.py +1 -1
  32. visier_platform_sdk/api/release_version_configuration_api.py +1 -1
  33. visier_platform_sdk/api/reporting_api.py +1 -1
  34. visier_platform_sdk/api/search_api.py +1 -1
  35. visier_platform_sdk/api/sidecar_solutions_api.py +1 -1
  36. visier_platform_sdk/api/skills_library_api.py +1 -1
  37. visier_platform_sdk/api/source_files_download_api.py +1 -1
  38. visier_platform_sdk/api/sources_api.py +4 -4
  39. visier_platform_sdk/api/system_status_api.py +1 -1
  40. visier_platform_sdk/api/tenants_v1_api.py +1 -1
  41. visier_platform_sdk/api/tenants_v2_api.py +1 -1
  42. visier_platform_sdk/api/user_groups_v2_api.py +1 -1
  43. visier_platform_sdk/api/users_v1_api.py +1 -1
  44. visier_platform_sdk/api/users_v2_api.py +1 -1
  45. visier_platform_sdk/api/users_v3_api.py +1 -1
  46. visier_platform_sdk/api/vee_api.py +1 -1
  47. visier_platform_sdk/api/webhooks_api.py +1 -1
  48. visier_platform_sdk/api_client.py +2 -2
  49. visier_platform_sdk/configuration.py +3 -3
  50. visier_platform_sdk/exceptions.py +1 -1
  51. visier_platform_sdk/models/__init__.py +25 -10
  52. visier_platform_sdk/models/accessible_tenant_profile_assignment_request_dto.py +1 -1
  53. visier_platform_sdk/models/accessible_tenant_profile_assignment_response_dto.py +1 -1
  54. visier_platform_sdk/models/accessible_tenant_profile_revoke_request_dto.py +1 -1
  55. visier_platform_sdk/models/accessible_tenant_profile_revoke_response_dto.py +1 -1
  56. visier_platform_sdk/models/additional_capabilities_dto.py +1 -1
  57. visier_platform_sdk/models/admin_capability_config_dto.py +1 -1
  58. visier_platform_sdk/models/adp_auth_params_dto.py +1 -1
  59. visier_platform_sdk/models/aggregate_query_execution_options_dto.py +1 -1
  60. visier_platform_sdk/models/aggregation_query_dto.py +1 -1
  61. visier_platform_sdk/models/aggregation_query_execution_dto.py +1 -1
  62. visier_platform_sdk/models/aggregation_query_source_dto.py +1 -1
  63. visier_platform_sdk/models/aggregation_query_source_metric_dto.py +1 -1
  64. visier_platform_sdk/models/aggregation_query_source_metrics_dto.py +1 -1
  65. visier_platform_sdk/models/aggregation_type_option_dto.py +1 -1
  66. visier_platform_sdk/models/aggregation_type_parameter_dto.py +1 -1
  67. visier_platform_sdk/models/aggregation_type_parameter_value_dto.py +1 -1
  68. visier_platform_sdk/models/all_permissions_assigned_for_local_tenant_dto.py +1 -1
  69. visier_platform_sdk/models/all_profile_assigned_for_accessible_tenant_dto.py +1 -1
  70. visier_platform_sdk/models/all_profile_assigned_for_local_tenant_dto.py +1 -1
  71. visier_platform_sdk/models/all_tenants_status_apidto.py +1 -1
  72. visier_platform_sdk/models/all_user_groups_assigned_for_local_tenant_dto.py +1 -1
  73. visier_platform_sdk/models/all_users_get_api_response_dto.py +1 -1
  74. visier_platform_sdk/models/analytic_object_definition_dto.py +1 -1
  75. visier_platform_sdk/models/{plans_patch_response.py → analytic_object_delete_request_dto.py} +15 -15
  76. visier_platform_sdk/models/analytic_object_delete_with_context_dto.py +97 -0
  77. visier_platform_sdk/models/analytic_object_details_dto.py +1 -1
  78. visier_platform_sdk/models/analytic_object_dto.py +1 -1
  79. visier_platform_sdk/models/analytic_object_filter_dto.py +1 -1
  80. visier_platform_sdk/models/analytic_object_filter_list_dto.py +1 -1
  81. visier_platform_sdk/models/analytic_object_names_dto.py +1 -1
  82. visier_platform_sdk/models/analytic_object_reference_dto.py +1 -1
  83. visier_platform_sdk/models/analytic_object_reference_list_dto.py +1 -1
  84. visier_platform_sdk/models/analytic_object_request_dto.py +1 -1
  85. visier_platform_sdk/models/analytic_object_response_dto.py +95 -0
  86. visier_platform_sdk/models/{plans_patch_response_action_result.py → analytic_object_revert_request_dto.py} +16 -18
  87. visier_platform_sdk/models/analytic_object_revert_with_context_dto.py +97 -0
  88. visier_platform_sdk/models/analytic_object_with_context_dto.py +1 -1
  89. visier_platform_sdk/models/analytic_objects_dto.py +1 -1
  90. visier_platform_sdk/models/any.py +1 -1
  91. visier_platform_sdk/models/api_error.py +1 -1
  92. visier_platform_sdk/models/assign_connector_credential_request.py +1 -1
  93. visier_platform_sdk/models/assign_connector_credentials_by_tenant_response_dto.py +1 -1
  94. visier_platform_sdk/models/assign_connector_credentials_response_dto.py +1 -1
  95. visier_platform_sdk/models/assign_connector_with_credentials_response_dto.py +1 -1
  96. visier_platform_sdk/models/assign_revoke_permission_by_permission_dto.py +1 -1
  97. visier_platform_sdk/models/assign_revoke_permission_by_tenant_dto.py +1 -1
  98. visier_platform_sdk/models/assign_revoke_permission_by_user_dto.py +1 -1
  99. visier_platform_sdk/models/assign_revoke_permission_request_dto.py +1 -1
  100. visier_platform_sdk/models/assign_revoke_permissions_request_dto.py +1 -1
  101. visier_platform_sdk/models/assign_revoke_permissions_response_dto.py +6 -4
  102. visier_platform_sdk/models/assigned_credential_info_response_dto.py +1 -1
  103. visier_platform_sdk/models/bamboo_auth_params_dto.py +1 -1
  104. visier_platform_sdk/models/basic_information_dto.py +1 -1
  105. visier_platform_sdk/models/basic_s3_auth_params_dto.py +1 -1
  106. visier_platform_sdk/models/batch_tenant_provision_apidto.py +1 -1
  107. visier_platform_sdk/models/benchmark_info.py +1 -1
  108. visier_platform_sdk/models/benchmark_value.py +1 -1
  109. visier_platform_sdk/models/between_rule_dto.py +1 -1
  110. visier_platform_sdk/models/big_query_auth_params_dto.py +1 -1
  111. visier_platform_sdk/models/big_query_service_account_params_dto.py +1 -1
  112. visier_platform_sdk/models/bulk_change_response_dto.py +1 -1
  113. visier_platform_sdk/models/bulk_data_access_set_request_dto.py +1 -1
  114. visier_platform_sdk/models/bulk_data_access_set_response_dto.py +1 -1
  115. visier_platform_sdk/models/business_location_dto.py +1 -1
  116. visier_platform_sdk/models/calculated_property_type_dto.py +1 -1
  117. visier_platform_sdk/models/calculated_selection_concept_dto.py +1 -1
  118. visier_platform_sdk/models/calculation_concept_configuration_dto.py +1 -1
  119. visier_platform_sdk/models/calculation_concept_configuration_map_dto.py +1 -1
  120. visier_platform_sdk/models/calculation_concept_dto.py +1 -1
  121. visier_platform_sdk/models/calculation_concept_list_dto.py +1 -1
  122. visier_platform_sdk/models/cancel_job_batch_from_job_id_dto.py +1 -1
  123. visier_platform_sdk/models/capabilities_dto.py +1 -1
  124. visier_platform_sdk/models/capability_dto.py +1 -1
  125. visier_platform_sdk/models/capability_group_dto.py +1 -1
  126. visier_platform_sdk/models/caption_dto.py +1 -1
  127. visier_platform_sdk/models/caption_list_dto.py +1 -1
  128. visier_platform_sdk/models/career_level_search_failure_output.py +1 -1
  129. visier_platform_sdk/models/career_level_search_input.py +1 -1
  130. visier_platform_sdk/models/career_level_search_output.py +1 -1
  131. visier_platform_sdk/models/career_level_search_successful_output.py +1 -1
  132. visier_platform_sdk/models/category_icon_dto.py +1 -1
  133. visier_platform_sdk/models/cell_distribution_bin_dto.py +1 -1
  134. visier_platform_sdk/models/cell_distribution_options_dto.py +1 -1
  135. visier_platform_sdk/models/cell_dto.py +1 -1
  136. visier_platform_sdk/models/cell_set_axis_dto.py +1 -1
  137. visier_platform_sdk/models/cell_set_axis_position_dto.py +1 -1
  138. visier_platform_sdk/models/cell_set_dto.py +1 -1
  139. visier_platform_sdk/models/cell_set_or_error_dto.py +1 -1
  140. visier_platform_sdk/models/clone_files_into_source_parameters_dto.py +1 -1
  141. visier_platform_sdk/models/cohort_filter_dto.py +1 -1
  142. visier_platform_sdk/models/collaboration_info.py +105 -0
  143. visier_platform_sdk/models/commit_and_publish_operation_response_dto.py +1 -1
  144. visier_platform_sdk/models/commit_dto.py +1 -1
  145. visier_platform_sdk/models/compared_metric_dto.py +1 -1
  146. visier_platform_sdk/models/concept_configuration_result_dto.py +1 -1
  147. visier_platform_sdk/models/concept_definition_dto.py +1 -1
  148. visier_platform_sdk/models/concept_delete_request_dto.py +1 -1
  149. visier_platform_sdk/models/concept_delete_with_context_dto.py +1 -1
  150. visier_platform_sdk/models/concept_reference_filter_dto.py +1 -1
  151. visier_platform_sdk/models/concept_request_dto.py +1 -1
  152. visier_platform_sdk/models/concept_response_dto.py +1 -1
  153. visier_platform_sdk/models/concept_type_details_dto.py +1 -1
  154. visier_platform_sdk/models/concept_with_context_dto.py +1 -1
  155. visier_platform_sdk/models/connector.py +1 -1
  156. visier_platform_sdk/models/connector_info_response_dto.py +1 -1
  157. visier_platform_sdk/models/connector_setting_request_dto.py +1 -1
  158. visier_platform_sdk/models/connector_setting_response_dto.py +1 -1
  159. visier_platform_sdk/models/connector_settings_response_dto.py +1 -1
  160. visier_platform_sdk/models/consolidate_action_payload.py +2 -2
  161. visier_platform_sdk/models/consolidated_analytics_api_excluded_source_list_dto.py +1 -1
  162. visier_platform_sdk/models/consolidated_analytics_api_source_tenant_list_dto.py +1 -1
  163. visier_platform_sdk/models/consolidated_analytics_api_tenant_create_request_dto.py +1 -1
  164. visier_platform_sdk/models/consolidated_analytics_api_tenant_list_response_dto.py +1 -1
  165. visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details.py +1 -1
  166. visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details_list_response_dto.py +1 -1
  167. visier_platform_sdk/models/consolidated_analytics_job_request_dto.py +1 -1
  168. visier_platform_sdk/models/content_package_dto.py +1 -1
  169. visier_platform_sdk/models/copy_s3_auth_params_dto.py +1 -1
  170. visier_platform_sdk/models/create_event_alert_request_dto.py +1 -1
  171. visier_platform_sdk/models/credential_creation_api_response_dto.py +1 -1
  172. visier_platform_sdk/models/currencies_dto.py +1 -1
  173. visier_platform_sdk/models/currency_dto.py +1 -1
  174. visier_platform_sdk/models/currency_rate_dto.py +1 -1
  175. visier_platform_sdk/models/currency_rates_dto.py +1 -1
  176. visier_platform_sdk/models/custom_property_dto.py +1 -1
  177. visier_platform_sdk/models/custom_tenant_property_dto.py +1 -1
  178. visier_platform_sdk/models/data_access_set_dto.py +1 -1
  179. visier_platform_sdk/models/data_access_set_error_dto.py +1 -1
  180. visier_platform_sdk/models/data_access_set_failure_dto.py +1 -1
  181. visier_platform_sdk/models/data_access_set_success_dto.py +1 -1
  182. visier_platform_sdk/models/data_categories_response_dto.py +1 -1
  183. visier_platform_sdk/models/data_category_response_dto.py +1 -1
  184. visier_platform_sdk/models/data_load_request.py +1 -1
  185. visier_platform_sdk/models/data_load_request_model.py +1 -1
  186. visier_platform_sdk/models/data_load_response.py +1 -1
  187. visier_platform_sdk/models/data_model_analytic_object_dto.py +1 -1
  188. visier_platform_sdk/models/data_provider_auth_information_dto.py +1 -1
  189. visier_platform_sdk/models/data_provider_auth_params_dto.py +1 -1
  190. visier_platform_sdk/models/data_provider_basic_information_dto.py +1 -1
  191. visier_platform_sdk/models/data_provider_basic_metadata_dto.py +1 -1
  192. visier_platform_sdk/models/data_security_profile_dto.py +1 -1
  193. visier_platform_sdk/models/data_transfer_result_detail.py +1 -1
  194. visier_platform_sdk/models/data_version_and_date_dto.py +1 -1
  195. visier_platform_sdk/models/data_version_export_column_dto.py +1 -1
  196. visier_platform_sdk/models/data_version_export_data_version_summary_dto.py +1 -1
  197. visier_platform_sdk/models/data_version_export_data_versions_dto.py +1 -1
  198. visier_platform_sdk/models/data_version_export_dto.py +1 -1
  199. visier_platform_sdk/models/data_version_export_file_dto.py +1 -1
  200. visier_platform_sdk/models/data_version_export_job_status_dto.py +1 -1
  201. visier_platform_sdk/models/data_version_export_part_file_dto.py +1 -1
  202. visier_platform_sdk/models/data_version_export_schedule_job_request_dto.py +1 -1
  203. visier_platform_sdk/models/data_version_export_schedule_job_response_dto.py +1 -1
  204. visier_platform_sdk/models/data_version_export_table_dto.py +1 -1
  205. visier_platform_sdk/models/data_version_exports_dto.py +1 -1
  206. visier_platform_sdk/models/data_version_object.py +1 -1
  207. visier_platform_sdk/models/databricks_auth_params_dto.py +1 -1
  208. visier_platform_sdk/models/date_range_dto.py +1 -1
  209. visier_platform_sdk/models/dayforce_v2_auth_params_dto.py +1 -1
  210. visier_platform_sdk/models/delete_email_domains_dto.py +1 -1
  211. visier_platform_sdk/models/delete_permissions_request_dto.py +1 -1
  212. visier_platform_sdk/models/delete_user_group_v2_request.py +1 -1
  213. visier_platform_sdk/models/dependent_dto.py +1 -1
  214. visier_platform_sdk/models/derived_metric_details_dto.py +105 -0
  215. visier_platform_sdk/models/description_entry.py +1 -1
  216. visier_platform_sdk/models/designer_dimension_filter_dto.py +1 -1
  217. visier_platform_sdk/models/designer_selection_concept_dto.py +1 -1
  218. visier_platform_sdk/models/dimension_change_definition_dto.py +1 -1
  219. visier_platform_sdk/models/dimension_change_definitions_by_tenant_dto.py +1 -1
  220. visier_platform_sdk/models/dimension_delete_request_dto.py +1 -1
  221. visier_platform_sdk/models/dimension_delete_with_context_dto.py +1 -1
  222. visier_platform_sdk/models/dimension_details_dto.py +1 -1
  223. visier_platform_sdk/models/dimension_dto.py +1 -1
  224. visier_platform_sdk/models/dimension_filter_dto.py +1 -1
  225. visier_platform_sdk/models/dimension_mapping_validation_dto.py +1 -1
  226. visier_platform_sdk/models/dimension_mapping_validation_execution_dto.py +1 -1
  227. visier_platform_sdk/models/dimension_member.py +1 -1
  228. visier_platform_sdk/models/dimension_member_dto.py +1 -1
  229. visier_platform_sdk/models/dimension_member_reference_dto.py +1 -1
  230. visier_platform_sdk/models/dimension_reference_dto.py +1 -1
  231. visier_platform_sdk/models/dimension_request_dto.py +1 -1
  232. visier_platform_sdk/models/dimension_response_dto.py +1 -1
  233. visier_platform_sdk/models/dimension_with_context_dto.py +1 -1
  234. visier_platform_sdk/models/dimensions_auth_params_dto.py +1 -1
  235. visier_platform_sdk/models/dimensions_change_definitions_dto.py +1 -1
  236. visier_platform_sdk/models/dimensions_dto.py +1 -1
  237. visier_platform_sdk/models/direct_data_job_config_dto.py +1 -1
  238. visier_platform_sdk/models/direct_data_job_status_response_dto.py +1 -1
  239. visier_platform_sdk/models/direct_data_list_transactions_response_dto.py +1 -1
  240. visier_platform_sdk/models/direct_data_load_config_dto.py +1 -1
  241. visier_platform_sdk/models/direct_data_schema_dto.py +1 -1
  242. visier_platform_sdk/models/direct_data_schema_field_dto.py +1 -1
  243. visier_platform_sdk/models/direct_data_transaction_dto.py +1 -1
  244. visier_platform_sdk/models/direct_data_transaction_start_response_dto.py +1 -1
  245. visier_platform_sdk/models/direct_data_upload_file_response_dto.py +1 -1
  246. visier_platform_sdk/models/disable_dv_model.py +1 -1
  247. visier_platform_sdk/models/disable_dv_request.py +1 -1
  248. visier_platform_sdk/models/disable_dv_response.py +1 -1
  249. visier_platform_sdk/models/dispatching_job_status_response.py +1 -1
  250. visier_platform_sdk/models/document_search_link_dto.py +1 -1
  251. visier_platform_sdk/models/download_source_files_dto.py +1 -1
  252. visier_platform_sdk/models/download_source_files_response_dto.py +1 -1
  253. visier_platform_sdk/models/dv_export_status.py +1 -1
  254. visier_platform_sdk/models/dynamic_dimension_filter_dto.py +1 -1
  255. visier_platform_sdk/models/dynamic_property_mapping_dto.py +1 -1
  256. visier_platform_sdk/models/element_ids_dto.py +1 -1
  257. visier_platform_sdk/models/email_domains_dto.py +1 -1
  258. visier_platform_sdk/models/end_collaboration_action_payload.py +97 -0
  259. visier_platform_sdk/models/error_dto.py +1 -1
  260. visier_platform_sdk/models/error_summary.py +1 -1
  261. visier_platform_sdk/models/event_alert_delete_success_dto.py +1 -1
  262. visier_platform_sdk/models/event_alert_dto.py +1 -1
  263. visier_platform_sdk/models/event_alert_notification_result_alert_details_dto.py +1 -1
  264. visier_platform_sdk/models/event_alert_notification_result_dto.py +1 -1
  265. visier_platform_sdk/models/event_alert_notification_results_dto.py +1 -1
  266. visier_platform_sdk/models/event_alert_trigger_criteria_dto.py +1 -1
  267. visier_platform_sdk/models/event_details_dto.py +1 -1
  268. visier_platform_sdk/models/exclude_data_uploads_request.py +1 -1
  269. visier_platform_sdk/models/excluded_sources_body.py +1 -1
  270. visier_platform_sdk/models/execution_context_dto.py +1 -1
  271. visier_platform_sdk/models/export_production_versions_api_operation_parameters_dto.py +1 -1
  272. visier_platform_sdk/models/extract_data_and_load_dto.py +1 -1
  273. visier_platform_sdk/models/extracted_skill.py +1 -1
  274. visier_platform_sdk/models/extraction_job.py +1 -1
  275. visier_platform_sdk/models/extraction_job_and_status_response.py +1 -1
  276. visier_platform_sdk/models/extractor_credential_apidto.py +1 -1
  277. visier_platform_sdk/models/extractor_credentials_apidto.py +1 -1
  278. visier_platform_sdk/models/extractor_setting_apidto.py +1 -1
  279. visier_platform_sdk/models/extractor_setting_key_value_apidto.py +1 -1
  280. visier_platform_sdk/models/extractor_settings_apidto.py +1 -1
  281. visier_platform_sdk/models/failed_accessible_tenant_profile_assignment_dto.py +1 -1
  282. visier_platform_sdk/models/failed_change_dto.py +1 -1
  283. visier_platform_sdk/models/failed_local_tenant_profile_assignment_dto.py +1 -1
  284. visier_platform_sdk/models/failed_local_tenant_profile_revoke_dto.py +1 -1
  285. visier_platform_sdk/models/filter_dto.py +1 -1
  286. visier_platform_sdk/models/fixed_time_type_dto.py +1 -1
  287. visier_platform_sdk/models/fusion_auth_params_dto.py +1 -1
  288. visier_platform_sdk/models/generate_impersonation_token_request.py +1 -1
  289. visier_platform_sdk/models/generate_key_request_dto.py +1 -1
  290. visier_platform_sdk/models/get_capabilities_api_response_dto.py +1 -1
  291. visier_platform_sdk/models/get_content_packages_api_response_dto.py +1 -1
  292. visier_platform_sdk/models/get_data_access_sets_api_response_dto.py +1 -1
  293. visier_platform_sdk/models/get_data_security_objects_api_response_dto.py +1 -1
  294. visier_platform_sdk/models/get_event_alerts_response_dto.py +1 -1
  295. visier_platform_sdk/models/get_permissions_api_response_dto.py +1 -1
  296. visier_platform_sdk/models/get_plan_list_response_dto.py +1 -1
  297. visier_platform_sdk/models/get_production_versions_api_response_dto.py +1 -1
  298. visier_platform_sdk/models/get_projects_api_response_dto.py +1 -1
  299. visier_platform_sdk/models/gong_auth_params_dto.py +1 -1
  300. visier_platform_sdk/models/google_sheets_auth_params_dto.py +1 -1
  301. visier_platform_sdk/models/google_workspace_auth_params_dto.py +1 -1
  302. visier_platform_sdk/models/greenhouse_auth_params_dto.py +1 -1
  303. visier_platform_sdk/models/grouped_metric_value_threshold_criteria_dto.py +1 -1
  304. visier_platform_sdk/models/hierarchy.py +1 -1
  305. visier_platform_sdk/models/hierarchy_property_dto.py +1 -1
  306. visier_platform_sdk/models/home_analysis_by_user_group_dto.py +1 -1
  307. visier_platform_sdk/models/icims_auth_params_dto.py +1 -1
  308. visier_platform_sdk/models/import_definition_apidto.py +1 -1
  309. visier_platform_sdk/models/import_definitions_apidto.py +1 -1
  310. visier_platform_sdk/models/include_data_uploads_request.py +1 -1
  311. visier_platform_sdk/models/inherited_access_config_dto.py +1 -1
  312. visier_platform_sdk/models/inherited_reference_member_filter_config_dto.py +1 -1
  313. visier_platform_sdk/models/internal_query_execution_options_dto.py +1 -1
  314. visier_platform_sdk/models/internal_s3_auth_params_dto.py +1 -1
  315. visier_platform_sdk/models/jdbc_auth_params_dto.py +1 -1
  316. visier_platform_sdk/models/jira_auth_params_dto.py +1 -1
  317. visier_platform_sdk/models/jira_connect_params_dto.py +1 -1
  318. visier_platform_sdk/models/job.py +1 -1
  319. visier_platform_sdk/models/job_cancellation_result_dto.py +1 -1
  320. visier_platform_sdk/models/job_cancellation_results_dto.py +1 -1
  321. visier_platform_sdk/models/job_entry.py +1 -1
  322. visier_platform_sdk/models/job_feedback_input.py +1 -1
  323. visier_platform_sdk/models/job_id_response.py +1 -1
  324. visier_platform_sdk/models/job_search_failure_output.py +1 -1
  325. visier_platform_sdk/models/job_search_input.py +1 -1
  326. visier_platform_sdk/models/job_search_output.py +1 -1
  327. visier_platform_sdk/models/job_standardization_input.py +1 -1
  328. visier_platform_sdk/models/job_standardization_input_skills.py +1 -1
  329. visier_platform_sdk/models/job_status_list_response.py +1 -1
  330. visier_platform_sdk/models/job_status_with_start_time.py +1 -1
  331. visier_platform_sdk/models/key_group_filter_dto.py +1 -1
  332. visier_platform_sdk/models/key_group_filter_item_dto.py +1 -1
  333. visier_platform_sdk/models/key_name.py +1 -1
  334. visier_platform_sdk/models/key_pair_delete_response_dto.py +1 -1
  335. visier_platform_sdk/models/key_pair_generate_request_dto.py +1 -1
  336. visier_platform_sdk/models/last_login_dto.py +1 -1
  337. visier_platform_sdk/models/level_dto.py +1 -1
  338. visier_platform_sdk/models/level_list_dto.py +1 -1
  339. visier_platform_sdk/models/leveled_details_dto.py +1 -1
  340. visier_platform_sdk/models/lever_auth_params_dto.py +1 -1
  341. visier_platform_sdk/models/lineage_dto.py +1 -1
  342. visier_platform_sdk/models/list_query_execution_dto.py +1 -1
  343. visier_platform_sdk/models/list_query_execution_options_dto.py +1 -1
  344. visier_platform_sdk/models/list_query_source_dto.py +1 -1
  345. visier_platform_sdk/models/list_response.py +1 -1
  346. visier_platform_sdk/models/local_or_shared_dimension_dto.py +1 -1
  347. visier_platform_sdk/models/local_or_shared_dimension_list_dto.py +1 -1
  348. visier_platform_sdk/models/local_tenant_profile_assignment_request_dto.py +1 -1
  349. visier_platform_sdk/models/local_tenant_profile_assignment_response_dto.py +1 -1
  350. visier_platform_sdk/models/local_tenant_profile_revoke_request_dto.py +1 -1
  351. visier_platform_sdk/models/local_tenant_profile_revoke_response_dto.py +1 -1
  352. visier_platform_sdk/models/location_search_failure_output.py +1 -1
  353. visier_platform_sdk/models/location_search_input.py +1 -1
  354. visier_platform_sdk/models/location_search_input1.py +1 -1
  355. visier_platform_sdk/models/location_search_output.py +1 -1
  356. visier_platform_sdk/models/location_search_successful_output.py +1 -1
  357. visier_platform_sdk/models/mask_message.py +1 -1
  358. visier_platform_sdk/models/medallia_auth_params_dto.py +1 -1
  359. visier_platform_sdk/models/member_dto.py +1 -1
  360. visier_platform_sdk/models/member_filter_config_dto.py +1 -1
  361. visier_platform_sdk/models/member_filter_dto.py +1 -1
  362. visier_platform_sdk/models/member_parameter_definition_dto.py +1 -1
  363. visier_platform_sdk/models/member_parameter_value_dto.py +1 -1
  364. visier_platform_sdk/models/member_selection_concept_dto.py +1 -1
  365. visier_platform_sdk/models/member_selection_dto.py +1 -1
  366. visier_platform_sdk/models/member_values_dto.py +1 -1
  367. visier_platform_sdk/models/members_dto.py +1 -1
  368. visier_platform_sdk/models/metric_definition_dto.py +131 -0
  369. visier_platform_sdk/models/{plans_patch_request.py → metric_delete_request_dto.py} +15 -15
  370. visier_platform_sdk/models/metric_delete_with_context_dto.py +97 -0
  371. visier_platform_sdk/models/metric_dto.py +1 -1
  372. visier_platform_sdk/models/metric_filter_parameter_value_dto.py +1 -1
  373. visier_platform_sdk/models/metric_request_dto.py +95 -0
  374. visier_platform_sdk/models/metric_response_dto.py +95 -0
  375. visier_platform_sdk/models/metric_type_details_dto.py +97 -0
  376. visier_platform_sdk/models/metric_validation_summary_dto.py +1 -1
  377. visier_platform_sdk/models/metric_with_context_dto.py +97 -0
  378. visier_platform_sdk/models/metrics_dto.py +1 -1
  379. visier_platform_sdk/models/microsoft365_auth_params_dto.py +1 -1
  380. visier_platform_sdk/models/module_settings_dto.py +1 -1
  381. visier_platform_sdk/models/multi_value_property_type_dto.py +1 -1
  382. visier_platform_sdk/models/multi_value_setting_dto.py +1 -1
  383. visier_platform_sdk/models/multiple_tenant_data_versions_details_dto.py +1 -1
  384. visier_platform_sdk/models/multiple_tenant_data_versions_list_dto.py +1 -1
  385. visier_platform_sdk/models/my_sql_auth_params_dto.py +1 -1
  386. visier_platform_sdk/models/namely_auth_params_dto.py +1 -1
  387. visier_platform_sdk/models/network_subnets_message_request.py +1 -1
  388. visier_platform_sdk/models/network_subnets_message_response.py +1 -1
  389. visier_platform_sdk/models/numeric_parameter_definition_dto.py +1 -1
  390. visier_platform_sdk/models/numeric_parameter_value_dto.py +1 -1
  391. visier_platform_sdk/models/numeric_range_dto.py +1 -1
  392. visier_platform_sdk/models/numeric_range_filter_dto.py +1 -1
  393. visier_platform_sdk/models/o_auth2_user_info_dto.py +1 -1
  394. visier_platform_sdk/models/o_auth2_user_subnet_info_dto.py +1 -1
  395. visier_platform_sdk/models/o_auth2_user_tenant_detail_dto.py +1 -1
  396. visier_platform_sdk/models/o_auth2_user_tenant_details_dto.py +1 -1
  397. visier_platform_sdk/models/o_auth2_user_tenant_properties_dto.py +1 -1
  398. visier_platform_sdk/models/object_change_failure_dto.py +1 -1
  399. visier_platform_sdk/models/object_change_success_dto.py +1 -1
  400. visier_platform_sdk/models/object_id_dto.py +1 -1
  401. visier_platform_sdk/models/object_reference_dto.py +1 -1
  402. visier_platform_sdk/models/objects_bulk_change_response_dto.py +1 -1
  403. visier_platform_sdk/models/oracle_db_auth_params_dto.py +1 -1
  404. visier_platform_sdk/models/other_metric_dto.py +1 -1
  405. visier_platform_sdk/models/output_entry.py +1 -1
  406. visier_platform_sdk/models/output_entry1.py +1 -1
  407. visier_platform_sdk/models/output_entry1_matches_inner.py +1 -1
  408. visier_platform_sdk/models/pair_dto.py +1 -1
  409. visier_platform_sdk/models/parameter_definition_dto.py +1 -1
  410. visier_platform_sdk/models/parent_child_details_dto.py +1 -1
  411. visier_platform_sdk/models/periods_back_dto.py +1 -1
  412. visier_platform_sdk/models/permission_assigned_by_tenant_dto.py +1 -1
  413. visier_platform_sdk/models/permission_assigned_for_local_tenant_dto.py +1 -1
  414. visier_platform_sdk/models/permission_assigned_user_dto.py +1 -1
  415. visier_platform_sdk/models/permission_assigned_users_dto.py +1 -1
  416. visier_platform_sdk/models/permission_bulk_operation_response_dto.py +1 -1
  417. visier_platform_sdk/models/permission_dto.py +1 -1
  418. visier_platform_sdk/models/permission_error_dto.py +1 -1
  419. visier_platform_sdk/models/permission_failure_dto.py +1 -1
  420. visier_platform_sdk/models/permission_response_dto.py +1 -1
  421. visier_platform_sdk/models/permission_success_dto.py +1 -1
  422. visier_platform_sdk/models/permissions_list_dto.py +1 -1
  423. visier_platform_sdk/models/permissions_to_user_group_for_tenant_dto.py +1 -1
  424. visier_platform_sdk/models/permissions_to_user_group_request_dto.py +1 -1
  425. visier_platform_sdk/models/permissions_to_user_groups_request_dto.py +1 -1
  426. visier_platform_sdk/models/persisted_cohort_filter_dto.py +1 -1
  427. visier_platform_sdk/models/perspective_configuration_dto.py +1 -1
  428. visier_platform_sdk/models/perspective_node_dto.py +1 -1
  429. visier_platform_sdk/models/plan_data_load_change_dto.py +1 -1
  430. visier_platform_sdk/models/plan_data_load_change_list_dto.py +1 -1
  431. visier_platform_sdk/models/plan_data_load_error_dto.py +1 -1
  432. visier_platform_sdk/models/plan_data_upload_response_dto.py +1 -1
  433. visier_platform_sdk/models/plan_info_dto.py +12 -2
  434. visier_platform_sdk/models/plan_item_dto.py +1 -1
  435. visier_platform_sdk/models/plan_parameter_definition_dto.py +1 -1
  436. visier_platform_sdk/models/plan_parameter_value_dto.py +1 -1
  437. visier_platform_sdk/models/plan_patch_consolidate_action_request.py +2 -2
  438. visier_platform_sdk/models/{plan_patch_consolidate_action_request_with_plan_id.py → plan_patch_end_collaboration_action_request.py} +15 -18
  439. visier_platform_sdk/models/plan_patch_reopen_action_request.py +2 -2
  440. visier_platform_sdk/models/plan_patch_start_collaboration_action_request.py +100 -0
  441. visier_platform_sdk/models/{plan_patch_reopen_action_request_with_plan_id.py → plan_patch_submit_action_request.py} +15 -18
  442. visier_platform_sdk/models/plan_row_data_load_response_dto.py +1 -1
  443. visier_platform_sdk/models/{plan_patch_action_result.py → plan_scenario_patch_action_result.py} +6 -6
  444. visier_platform_sdk/models/{plan_patch_request.py → plan_scenario_patch_request.py} +55 -13
  445. visier_platform_sdk/models/{plan_patch_response.py → plan_scenario_patch_response.py} +7 -7
  446. visier_platform_sdk/models/plan_schema_dto.py +1 -1
  447. visier_platform_sdk/models/plan_segment_level_dto.py +1 -1
  448. visier_platform_sdk/models/plan_segment_level_member_dto.py +1 -1
  449. visier_platform_sdk/models/plan_segment_level_member_list_dto.py +1 -1
  450. visier_platform_sdk/models/plan_time_period_dto.py +1 -1
  451. visier_platform_sdk/models/plan_with_schema_dto.py +1 -1
  452. visier_platform_sdk/models/planning_concept_filter_context_dto.py +1 -1
  453. visier_platform_sdk/models/planning_hierarchy_filter_context_dto.py +1 -1
  454. visier_platform_sdk/models/planning_model_dto.py +1 -1
  455. visier_platform_sdk/models/planning_models_dto.py +1 -1
  456. visier_platform_sdk/models/planning_plan_context_dto.py +1 -1
  457. visier_platform_sdk/models/planning_plan_dto.py +1 -1
  458. visier_platform_sdk/models/planning_plans_dto.py +1 -1
  459. visier_platform_sdk/models/population_configuration_dto.py +1 -1
  460. visier_platform_sdk/models/prediction_dto.py +1 -1
  461. visier_platform_sdk/models/predictions_dto.py +1 -1
  462. visier_platform_sdk/models/process_concept_definition_dto.py +1 -1
  463. visier_platform_sdk/models/process_concept_member_dto.py +1 -1
  464. visier_platform_sdk/models/process_concept_member_list_dto.py +1 -1
  465. visier_platform_sdk/models/process_concept_metric_definition_dto.py +1 -1
  466. visier_platform_sdk/models/process_concept_metric_details_dto.py +1 -1
  467. visier_platform_sdk/models/process_concept_metric_list_dto.py +1 -1
  468. visier_platform_sdk/models/process_concept_metric_type_details_dto.py +1 -1
  469. visier_platform_sdk/models/process_concept_outcome_dto.py +1 -1
  470. visier_platform_sdk/models/process_concept_outcome_list_dto.py +1 -1
  471. visier_platform_sdk/models/process_concept_property_details_dto.py +1 -1
  472. visier_platform_sdk/models/process_concept_property_dto.py +1 -1
  473. visier_platform_sdk/models/process_concept_property_list_dto.py +1 -1
  474. visier_platform_sdk/models/process_concept_property_type_dto.py +1 -1
  475. visier_platform_sdk/models/process_concept_stage_dto.py +1 -1
  476. visier_platform_sdk/models/process_concept_stage_list_dto.py +1 -1
  477. visier_platform_sdk/models/processing_job.py +1 -1
  478. visier_platform_sdk/models/processing_job_and_status_response.py +1 -1
  479. visier_platform_sdk/models/processing_job_request_dto.py +1 -1
  480. visier_platform_sdk/models/processing_job_status_response.py +1 -1
  481. visier_platform_sdk/models/product_release_dto.py +1 -1
  482. visier_platform_sdk/models/product_releases_dto.py +1 -1
  483. visier_platform_sdk/models/product_version_dto.py +1 -1
  484. visier_platform_sdk/models/product_versions_dto.py +1 -1
  485. visier_platform_sdk/models/product_versions_update_failure_tenant_response_dto.py +1 -1
  486. visier_platform_sdk/models/product_versions_update_response_dto.py +1 -1
  487. visier_platform_sdk/models/product_versions_update_successful_tenant_response_dto.py +1 -1
  488. visier_platform_sdk/models/production_version_api_operation_request_dto.py +1 -1
  489. visier_platform_sdk/models/production_version_api_operation_response_dto.py +1 -1
  490. visier_platform_sdk/models/production_versions_api_operation_request_dto.py +1 -1
  491. visier_platform_sdk/models/production_versions_api_operation_response_dto.py +1 -1
  492. visier_platform_sdk/models/profile_assigned_for_accessible_tenant_dto.py +1 -1
  493. visier_platform_sdk/models/profile_assigned_for_local_tenant_dto.py +1 -1
  494. visier_platform_sdk/models/profile_assignment_dto.py +1 -1
  495. visier_platform_sdk/models/profile_get_api_response_dto.py +1 -1
  496. visier_platform_sdk/models/profiles_get_api_response_dto.py +1 -1
  497. visier_platform_sdk/models/project_commit_dto.py +1 -1
  498. visier_platform_sdk/models/project_commits_api_response_dto.py +1 -1
  499. visier_platform_sdk/models/project_dto.py +1 -1
  500. visier_platform_sdk/models/project_operation_request_dto.py +1 -1
  501. visier_platform_sdk/models/project_operation_response_dto.py +1 -1
  502. visier_platform_sdk/models/properties_change_definitions_dto.py +1 -1
  503. visier_platform_sdk/models/properties_delete_definitions_dto.py +1 -1
  504. visier_platform_sdk/models/properties_dto.py +1 -1
  505. visier_platform_sdk/models/property_access_config_dto.py +1 -1
  506. visier_platform_sdk/models/property_bulk_delete_response_dto.py +1 -1
  507. visier_platform_sdk/models/property_change_definition_dto.py +1 -1
  508. visier_platform_sdk/models/property_change_definitions_by_tenant_dto.py +1 -1
  509. visier_platform_sdk/models/property_column_dto.py +1 -1
  510. visier_platform_sdk/models/property_definition_dto.py +1 -1
  511. visier_platform_sdk/models/property_definition_list_dto.py +1 -1
  512. visier_platform_sdk/models/property_delete_definitions_by_tenant_dto.py +1 -1
  513. visier_platform_sdk/models/property_delete_failure_dto.py +1 -1
  514. visier_platform_sdk/models/property_delete_success_dto.py +1 -1
  515. visier_platform_sdk/models/property_dependency_dto.py +1 -1
  516. visier_platform_sdk/models/property_dependency_list_dto.py +1 -1
  517. visier_platform_sdk/models/property_dto.py +1 -1
  518. visier_platform_sdk/models/property_reference_dto.py +1 -1
  519. visier_platform_sdk/models/property_set_config_dto.py +1 -1
  520. visier_platform_sdk/models/property_type_details_dto.py +1 -1
  521. visier_platform_sdk/models/property_type_dto.py +1 -1
  522. visier_platform_sdk/models/public_key_dto.py +1 -1
  523. visier_platform_sdk/models/public_keys_dto.py +1 -1
  524. visier_platform_sdk/models/push_data_cancel_response.py +1 -1
  525. visier_platform_sdk/models/push_data_column_definition_dto.py +1 -1
  526. visier_platform_sdk/models/push_data_complete_request.py +1 -1
  527. visier_platform_sdk/models/push_data_complete_response.py +1 -1
  528. visier_platform_sdk/models/push_data_response.py +1 -1
  529. visier_platform_sdk/models/push_data_source_definition_dto.py +1 -1
  530. visier_platform_sdk/models/push_data_source_definitions_dto.py +1 -1
  531. visier_platform_sdk/models/qualtrics_auth_params_dto.py +1 -1
  532. visier_platform_sdk/models/query_axis_dto.py +1 -1
  533. visier_platform_sdk/models/query_axis_options_dto.py +1 -1
  534. visier_platform_sdk/models/query_dimension_data_member_selection_dto.py +1 -1
  535. visier_platform_sdk/models/query_dimension_leaf_selection_dto.py +1 -1
  536. visier_platform_sdk/models/query_dimension_level_property_dto.py +1 -1
  537. visier_platform_sdk/models/query_dimension_level_selection_dto.py +1 -1
  538. visier_platform_sdk/models/query_dimension_member_selection_dto.py +1 -1
  539. visier_platform_sdk/models/query_execution_error_details_dto.py +1 -1
  540. visier_platform_sdk/models/query_execution_error_dto.py +1 -1
  541. visier_platform_sdk/models/query_execution_errors_dto.py +1 -1
  542. visier_platform_sdk/models/query_filter_dto.py +1 -1
  543. visier_platform_sdk/models/query_member_map_property_dto.py +1 -1
  544. visier_platform_sdk/models/query_member_map_selection_dto.py +1 -1
  545. visier_platform_sdk/models/query_numeric_ranges_dto.py +1 -1
  546. visier_platform_sdk/models/query_parameter_value_dto.py +1 -1
  547. visier_platform_sdk/models/query_property_dto.py +1 -1
  548. visier_platform_sdk/models/query_time_interval_dto.py +1 -1
  549. visier_platform_sdk/models/query_time_interval_dto_with_dynamic_date_from.py +1 -1
  550. visier_platform_sdk/models/query_time_interval_dto_with_from_datetime.py +1 -1
  551. visier_platform_sdk/models/query_time_interval_dto_with_from_instant.py +1 -1
  552. visier_platform_sdk/models/query_time_intervals_dto.py +1 -1
  553. visier_platform_sdk/models/query_time_intervals_dto_with_dynamic_date_from.py +1 -1
  554. visier_platform_sdk/models/query_time_intervals_dto_with_from_datetime.py +1 -1
  555. visier_platform_sdk/models/query_time_intervals_dto_with_from_instant.py +1 -1
  556. visier_platform_sdk/models/question_categories_api_response_dto.py +1 -1
  557. visier_platform_sdk/models/question_category_api_response_dto.py +1 -1
  558. visier_platform_sdk/models/receiving_job.py +1 -1
  559. visier_platform_sdk/models/receiving_job_and_status_response.py +1 -1
  560. visier_platform_sdk/models/receiving_job_extracted_file_response_dto.py +1 -1
  561. visier_platform_sdk/models/receiving_job_extracted_files_for_tenant_response_dto.py +1 -1
  562. visier_platform_sdk/models/receiving_job_extracted_files_list_response_dto.py +1 -1
  563. visier_platform_sdk/models/receiving_job_status_response.py +1 -1
  564. visier_platform_sdk/models/redshift_auth_params_dto.py +1 -1
  565. visier_platform_sdk/models/reduced_error_dto.py +1 -1
  566. visier_platform_sdk/models/reduced_tenant_code_error_dto.py +1 -1
  567. visier_platform_sdk/models/reduced_user_id_error_dto.py +1 -1
  568. visier_platform_sdk/models/related_analytic_object_dto.py +1 -1
  569. visier_platform_sdk/models/relative_time_expression_dto.py +1 -1
  570. visier_platform_sdk/models/relative_time_period_dto.py +1 -1
  571. visier_platform_sdk/models/relative_time_selection_dto.py +1 -1
  572. visier_platform_sdk/models/relative_time_shift_dto.py +1 -1
  573. visier_platform_sdk/models/relative_to_rule_dto.py +1 -1
  574. visier_platform_sdk/models/reopen_action_payload.py +3 -3
  575. visier_platform_sdk/models/report_create_request_dto.py +1 -1
  576. visier_platform_sdk/models/report_delete_success_dto.py +1 -1
  577. visier_platform_sdk/models/report_dto.py +1 -1
  578. visier_platform_sdk/models/report_list_response_dto.py +1 -1
  579. visier_platform_sdk/models/result.py +1 -1
  580. visier_platform_sdk/models/role_modules_config_dto.py +1 -1
  581. visier_platform_sdk/models/rule_dto.py +1 -1
  582. visier_platform_sdk/models/rule_set_dto.py +1 -1
  583. visier_platform_sdk/models/salary_benchmark_feedback_input.py +1 -1
  584. visier_platform_sdk/models/salary_benchmark_input.py +1 -1
  585. visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +1 -1
  586. visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +1 -1
  587. visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +1 -1
  588. visier_platform_sdk/models/salesforce_auth_params_dto.py +1 -1
  589. visier_platform_sdk/models/salesforce_v2_auth_params_dto.py +1 -1
  590. visier_platform_sdk/models/same_metric_other_context_dto.py +1 -1
  591. visier_platform_sdk/models/same_metric_other_time_dto.py +1 -1
  592. visier_platform_sdk/models/sample_question_api_response_dto.py +1 -1
  593. visier_platform_sdk/models/sample_questions_api_response_dto.py +1 -1
  594. visier_platform_sdk/models/scenario_info_dto.py +1 -1
  595. visier_platform_sdk/models/scenario_or_snapshot_dto.py +1 -1
  596. visier_platform_sdk/models/securable_dimension_dto.py +1 -1
  597. visier_platform_sdk/models/securable_property_dto.py +1 -1
  598. visier_platform_sdk/models/security_assignment_response_dto.py +1 -1
  599. visier_platform_sdk/models/selection_concept_configuration_dto.py +1 -1
  600. visier_platform_sdk/models/selection_concept_configuration_map_dto.py +1 -1
  601. visier_platform_sdk/models/selection_concept_dto.py +1 -1
  602. visier_platform_sdk/models/selection_concept_list_dto.py +1 -1
  603. visier_platform_sdk/models/selection_concept_reference_dto.py +1 -1
  604. visier_platform_sdk/models/selection_concepts_dto.py +1 -1
  605. visier_platform_sdk/models/service_now_auth_params_dto.py +1 -1
  606. visier_platform_sdk/models/service_now_v2_auth_params_dto.py +1 -1
  607. visier_platform_sdk/models/servicing_capability_proto_enum_access_lookup_dto.py +1 -1
  608. visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +1 -1
  609. visier_platform_sdk/models/set_connector_setting_request_dto.py +1 -1
  610. visier_platform_sdk/models/set_connector_setting_response_dto.py +1 -1
  611. visier_platform_sdk/models/set_connector_settings_request_dto.py +1 -1
  612. visier_platform_sdk/models/set_connector_settings_response_dto.py +1 -1
  613. visier_platform_sdk/models/settings_dto.py +1 -1
  614. visier_platform_sdk/models/shareable_data_access_set.py +1 -1
  615. visier_platform_sdk/models/sidecar_solution_request_dto.py +1 -1
  616. visier_platform_sdk/models/sidecar_solution_settings_dto.py +1 -1
  617. visier_platform_sdk/models/simple_document_header_search_response_dto.py +1 -1
  618. visier_platform_sdk/models/simple_document_header_search_result_dto.py +1 -1
  619. visier_platform_sdk/models/simple_metric_details_dto.py +89 -0
  620. visier_platform_sdk/models/simple_property_type_dto.py +1 -1
  621. visier_platform_sdk/models/simple_user_dto.py +1 -1
  622. visier_platform_sdk/models/single_value_setting_dto.py +1 -1
  623. visier_platform_sdk/models/skill.py +1 -1
  624. visier_platform_sdk/models/skill_category.py +1 -1
  625. visier_platform_sdk/models/skill_category_entry.py +1 -1
  626. visier_platform_sdk/models/skill_entry.py +1 -1
  627. visier_platform_sdk/models/skill_extraction_input.py +1 -1
  628. visier_platform_sdk/models/skill_group.py +1 -1
  629. visier_platform_sdk/models/skill_group_entry.py +1 -1
  630. visier_platform_sdk/models/skill_match_input.py +1 -1
  631. visier_platform_sdk/models/slack_auth_params_dto.py +1 -1
  632. visier_platform_sdk/models/snapshot_query_execution_dto.py +1 -1
  633. visier_platform_sdk/models/snapshot_query_execution_options_dto.py +1 -1
  634. visier_platform_sdk/models/snowflake_auth_params_dto.py +1 -1
  635. visier_platform_sdk/models/sort_option_dto.py +1 -1
  636. visier_platform_sdk/models/source.py +1 -1
  637. visier_platform_sdk/models/source_file_response_dto.py +1 -1
  638. visier_platform_sdk/models/source_import_result_summary_dto.py +1 -1
  639. visier_platform_sdk/models/sources_api_operation_request_dto.py +1 -1
  640. visier_platform_sdk/models/sources_api_put_response_dto.py +1 -1
  641. visier_platform_sdk/models/sql_like200_response.py +1 -1
  642. visier_platform_sdk/models/sql_like_query_execution_dto.py +1 -1
  643. visier_platform_sdk/models/sql_server_auth_params_dto.py +1 -1
  644. visier_platform_sdk/models/start_collaboration_action_payload.py +89 -0
  645. visier_platform_sdk/models/start_extraction_response.py +1 -1
  646. visier_platform_sdk/models/start_transfer_response.py +1 -1
  647. visier_platform_sdk/models/static_dimension_filter_dto.py +1 -1
  648. visier_platform_sdk/models/status.py +1 -1
  649. visier_platform_sdk/models/subject_details_dto.py +1 -1
  650. visier_platform_sdk/models/subject_member_set_parameter_value_dto.py +1 -1
  651. visier_platform_sdk/models/subject_member_set_parameter_value_dto_list_of_name_path_dto.py +1 -1
  652. visier_platform_sdk/models/subject_member_set_parameter_value_dto_name_path_dto.py +1 -1
  653. visier_platform_sdk/models/subject_missing_access_dto.py +1 -1
  654. visier_platform_sdk/models/subject_reference_dto.py +1 -1
  655. visier_platform_sdk/models/subject_reference_list_dto.py +1 -1
  656. visier_platform_sdk/models/submit_action_payload.py +87 -0
  657. visier_platform_sdk/models/success_factors_auth_params_dto.py +1 -1
  658. visier_platform_sdk/models/success_factors_o_auth_params_dto.py +1 -1
  659. visier_platform_sdk/models/successful_accessible_tenant_profile_assignment_dto.py +1 -1
  660. visier_platform_sdk/models/successful_change_dto.py +1 -1
  661. visier_platform_sdk/models/successful_local_tenant_profile_assignment_dto.py +1 -1
  662. visier_platform_sdk/models/synonym_list_dto.py +1 -1
  663. visier_platform_sdk/models/system_status_dto.py +1 -1
  664. visier_platform_sdk/models/table_response_dto.py +1 -1
  665. visier_platform_sdk/models/tag_map_element_dto.py +1 -1
  666. visier_platform_sdk/models/tag_reference_dto.py +1 -1
  667. visier_platform_sdk/models/tag_reference_list_dto.py +1 -1
  668. visier_platform_sdk/models/tags_dto.py +1 -1
  669. visier_platform_sdk/models/target_project_for_tenant_dto.py +1 -1
  670. visier_platform_sdk/models/target_project_for_tenants_list_dto.py +1 -1
  671. visier_platform_sdk/models/target_tenant_code_dto.py +1 -1
  672. visier_platform_sdk/models/tenant.py +1 -1
  673. visier_platform_sdk/models/tenant_and_credential.py +1 -1
  674. visier_platform_sdk/models/tenant_assignments_dto.py +1 -1
  675. visier_platform_sdk/models/tenant_code_body.py +1 -1
  676. visier_platform_sdk/models/tenant_code_error_dto.py +1 -1
  677. visier_platform_sdk/models/tenant_connector_settings_request_dto.py +1 -1
  678. visier_platform_sdk/models/tenant_data_upload_status_response_dto.py +1 -1
  679. visier_platform_sdk/models/tenant_data_upload_update_status_response_dto.py +1 -1
  680. visier_platform_sdk/models/tenant_data_uploads_list_response_dto.py +1 -1
  681. visier_platform_sdk/models/tenant_data_uploads_response_dto.py +1 -1
  682. visier_platform_sdk/models/tenant_data_uploads_update_response_dto.py +1 -1
  683. visier_platform_sdk/models/tenant_detail_apidto.py +1 -1
  684. visier_platform_sdk/models/tenant_details_traits_dto.py +1 -1
  685. visier_platform_sdk/models/tenant_encryption_key_details_dto.py +1 -1
  686. visier_platform_sdk/models/tenant_encryption_key_dto.py +1 -1
  687. visier_platform_sdk/models/tenant_management_api_get_response_dto.py +1 -1
  688. visier_platform_sdk/models/tenant_management_api_list_response_dto.py +1 -1
  689. visier_platform_sdk/models/tenant_management_api_update_request_dto.py +1 -1
  690. visier_platform_sdk/models/tenant_management_api_update_response_dto.py +6 -4
  691. visier_platform_sdk/models/tenant_module_dto.py +1 -1
  692. visier_platform_sdk/models/tenant_preview_entries_summary_dto.py +1 -1
  693. visier_platform_sdk/models/tenant_preview_entries_summary_list_dto.py +1 -1
  694. visier_platform_sdk/models/tenant_provision_apidto.py +1 -1
  695. visier_platform_sdk/models/tenant_source_files_list_response_dto.py +1 -1
  696. visier_platform_sdk/models/tenant_status_apidto.py +1 -1
  697. visier_platform_sdk/models/time_handling_dto.py +1 -1
  698. visier_platform_sdk/models/time_period_dto.py +1 -1
  699. visier_platform_sdk/models/time_period_filter_dto.py +1 -1
  700. visier_platform_sdk/models/time_period_metadata_dto.py +1 -1
  701. visier_platform_sdk/models/time_shift_dto.py +1 -1
  702. visier_platform_sdk/models/token_response.py +1 -1
  703. visier_platform_sdk/models/trigger_criteria_member_result_info_dto.py +1 -1
  704. visier_platform_sdk/models/trigger_criteria_overall_result_info_dto.py +1 -1
  705. visier_platform_sdk/models/trigger_criteria_result_info_dto.py +1 -1
  706. visier_platform_sdk/models/ultimate_auth_params_dto.py +1 -1
  707. visier_platform_sdk/models/update_event_alert_recipient_status_dto.py +1 -1
  708. visier_platform_sdk/models/update_tenant_model.py +1 -1
  709. visier_platform_sdk/models/upload_to_exclude.py +1 -1
  710. visier_platform_sdk/models/upload_to_include.py +1 -1
  711. visier_platform_sdk/models/user_creation_api_request_dto.py +1 -1
  712. visier_platform_sdk/models/user_creation_api_response_dto.py +1 -1
  713. visier_platform_sdk/models/user_get_api_response_dto.py +1 -1
  714. visier_platform_sdk/models/user_group_assigned_for_local_tenant_dto.py +1 -1
  715. visier_platform_sdk/models/user_group_assignment_dto.py +1 -1
  716. visier_platform_sdk/models/user_group_change_definition_dto.py +1 -1
  717. visier_platform_sdk/models/user_group_change_dimension_filter_dto.py +1 -1
  718. visier_platform_sdk/models/user_group_change_failure_dto.py +1 -1
  719. visier_platform_sdk/models/user_group_change_filter_dto.py +1 -1
  720. visier_platform_sdk/models/user_group_change_member_selection_dto.py +1 -1
  721. visier_platform_sdk/models/user_group_change_response_dto.py +1 -1
  722. visier_platform_sdk/models/user_group_change_success_dto.py +1 -1
  723. visier_platform_sdk/models/user_group_change_users_dto.py +1 -1
  724. visier_platform_sdk/models/user_group_delete_dto.py +1 -1
  725. visier_platform_sdk/models/user_group_delete_failure_dto.py +1 -1
  726. visier_platform_sdk/models/user_group_delete_response_dto.py +1 -1
  727. visier_platform_sdk/models/user_group_delete_success_dto.py +1 -1
  728. visier_platform_sdk/models/user_group_filters_dto.py +1 -1
  729. visier_platform_sdk/models/user_group_get_api_response_dto.py +1 -1
  730. visier_platform_sdk/models/user_group_single_delete_response_dto.py +1 -1
  731. visier_platform_sdk/models/user_groups_change_dto.py +1 -1
  732. visier_platform_sdk/models/user_groups_delete_request_dto.py +1 -1
  733. visier_platform_sdk/models/user_groups_get_api_response_dto.py +1 -1
  734. visier_platform_sdk/models/user_groups_users_dto.py +1 -1
  735. visier_platform_sdk/models/user_groups_users_for_tenant_dto.py +1 -1
  736. visier_platform_sdk/models/user_id_error_dto.py +1 -1
  737. visier_platform_sdk/models/user_property_dto.py +1 -1
  738. visier_platform_sdk/models/user_security_assignments_dto.py +1 -1
  739. visier_platform_sdk/models/user_update_api_request_dto.py +1 -1
  740. visier_platform_sdk/models/user_v3_api_request_dto.py +1 -1
  741. visier_platform_sdk/models/user_v3_api_response_dto.py +1 -1
  742. visier_platform_sdk/models/users_api_error_message_dto.py +1 -1
  743. visier_platform_sdk/models/users_api_failure_dto.py +1 -1
  744. visier_platform_sdk/models/users_api_response_dto.py +1 -1
  745. visier_platform_sdk/models/users_api_success_dto.py +1 -1
  746. visier_platform_sdk/models/users_creation_api_request_dto.py +1 -1
  747. visier_platform_sdk/models/users_delete_api_request_dto.py +1 -1
  748. visier_platform_sdk/models/users_to_user_group_request_dto.py +1 -1
  749. visier_platform_sdk/models/users_to_user_groups_request_dto.py +1 -1
  750. visier_platform_sdk/models/users_update_api_request_dto.py +1 -1
  751. visier_platform_sdk/models/users_update_api_user_dto.py +1 -1
  752. visier_platform_sdk/models/v2_calculated_property_type_dto.py +1 -1
  753. visier_platform_sdk/models/v2_dimension_dto.py +1 -1
  754. visier_platform_sdk/models/v2_level_dto.py +1 -1
  755. visier_platform_sdk/models/v2_simple_property_type_dto.py +1 -1
  756. visier_platform_sdk/models/validity_range_dto.py +1 -1
  757. visier_platform_sdk/models/vee_clarification_dto.py +1 -1
  758. visier_platform_sdk/models/vee_conversation_dto.py +1 -1
  759. visier_platform_sdk/models/vee_conversation_state_dto.py +1 -1
  760. visier_platform_sdk/models/vee_corrections_dto.py +1 -1
  761. visier_platform_sdk/models/vee_data_dto.py +1 -1
  762. visier_platform_sdk/models/vee_detail_data_dto.py +1 -1
  763. visier_platform_sdk/models/vee_feedback_dto.py +1 -1
  764. visier_platform_sdk/models/vee_options_dto.py +1 -1
  765. visier_platform_sdk/models/vee_question_categories_bulk_change_response_dto.py +1 -1
  766. visier_platform_sdk/models/vee_question_categories_change_definitions_dto.py +1 -1
  767. visier_platform_sdk/models/vee_question_categories_delete_definitions_dto.py +1 -1
  768. visier_platform_sdk/models/vee_question_category_change_definition_dto.py +1 -1
  769. visier_platform_sdk/models/vee_question_category_change_definitions_by_tenant_dto.py +1 -1
  770. visier_platform_sdk/models/vee_question_category_change_failure_dto.py +1 -1
  771. visier_platform_sdk/models/vee_question_category_change_success_dto.py +1 -1
  772. visier_platform_sdk/models/vee_question_category_delete_definitions_by_tenant_dto.py +1 -1
  773. visier_platform_sdk/models/vee_question_change_definition_dto.py +1 -1
  774. visier_platform_sdk/models/vee_question_change_definitions_by_tenant_dto.py +1 -1
  775. visier_platform_sdk/models/vee_question_change_failure_dto.py +1 -1
  776. visier_platform_sdk/models/vee_question_change_success_dto.py +1 -1
  777. visier_platform_sdk/models/vee_question_delete_definitions_by_tenant_dto.py +1 -1
  778. visier_platform_sdk/models/vee_question_dto.py +1 -1
  779. visier_platform_sdk/models/vee_questions_bulk_change_response_dto.py +1 -1
  780. visier_platform_sdk/models/vee_questions_change_definitions_dto.py +1 -1
  781. visier_platform_sdk/models/vee_questions_delete_definitions_dto.py +1 -1
  782. visier_platform_sdk/models/vee_response_dto.py +1 -1
  783. visier_platform_sdk/models/vee_response_schema_dto.py +1 -1
  784. visier_platform_sdk/models/vee_response_schema_reference_dto.py +1 -1
  785. visier_platform_sdk/models/vee_sample_question_dto.py +1 -1
  786. visier_platform_sdk/models/vee_sample_question_library_dto.py +1 -1
  787. visier_platform_sdk/models/vee_status_code_dto.py +1 -1
  788. visier_platform_sdk/models/vee_status_dto.py +1 -1
  789. visier_platform_sdk/models/vee_visual_dto.py +1 -1
  790. visier_platform_sdk/models/vee_visual_options_dto.py +1 -1
  791. visier_platform_sdk/models/version_information_dto.py +1 -1
  792. visier_platform_sdk/models/visible_for_selection_dto.py +1 -1
  793. visier_platform_sdk/models/webhook_basic_auth_credential_dto.py +1 -1
  794. visier_platform_sdk/models/webhook_credentials_dto.py +1 -1
  795. visier_platform_sdk/models/webhook_details_dto.py +1 -1
  796. visier_platform_sdk/models/webhook_dto.py +1 -1
  797. visier_platform_sdk/models/webhook_event_type_dto.py +1 -1
  798. visier_platform_sdk/models/webhook_message_response_dto.py +1 -1
  799. visier_platform_sdk/models/webhook_request_dto.py +1 -1
  800. visier_platform_sdk/models/webhooks_dto.py +1 -1
  801. visier_platform_sdk/models/willow_auth_params_dto.py +1 -1
  802. visier_platform_sdk/models/workday_auth_params_dto.py +1 -1
  803. visier_platform_sdk/models/workday_o_auth_params_dto.py +1 -1
  804. visier_platform_sdk/models/workday_raas_auth_params_dto.py +1 -1
  805. visier_platform_sdk/models/workday_refresh_token_params_dto.py +1 -1
  806. visier_platform_sdk/models/zoom_auth_params_dto.py +1 -1
  807. visier_platform_sdk/rest.py +1 -1
  808. {visier_platform_sdk-22222222.99201.2145.dist-info → visier_platform_sdk-22222222.99201.2174.dist-info}/METADATA +1 -1
  809. visier_platform_sdk-22222222.99201.2174.dist-info/RECORD +813 -0
  810. visier_platform_sdk/models/plans_patch_request_plan_item.py +0 -140
  811. visier_platform_sdk-22222222.99201.2145.dist-info/RECORD +0 -796
  812. {visier_platform_sdk-22222222.99201.2145.dist-info → visier_platform_sdk-22222222.99201.2174.dist-info}/WHEEL +0 -0
  813. {visier_platform_sdk-22222222.99201.2145.dist-info → visier_platform_sdk-22222222.99201.2174.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,2286 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ API Reference
5
+
6
+ Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
7
+
8
+ The version of the OpenAPI document: 22222222.99201.2174
9
+ Contact: alpine@visier.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr, field_validator
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from uuid import UUID
23
+ from visier_platform_sdk.models.bulk_change_response_dto import BulkChangeResponseDTO
24
+ from visier_platform_sdk.models.metric_delete_request_dto import MetricDeleteRequestDTO
25
+ from visier_platform_sdk.models.metric_request_dto import MetricRequestDTO
26
+ from visier_platform_sdk.models.metric_response_dto import MetricResponseDTO
27
+
28
+ from visier_platform_sdk.api_client import ApiClient, RequestSerialized
29
+ from visier_platform_sdk.api_response import ApiResponse
30
+ from visier_platform_sdk.rest import RESTResponseType
31
+
32
+
33
+ class MetricsV2Api:
34
+ """NOTE: This class is auto generated by OpenAPI Generator
35
+ Ref: https://openapi-generator.tech
36
+
37
+ Do not edit the class manually.
38
+ """
39
+
40
+ def __init__(self, api_client=None) -> None:
41
+ if api_client is None:
42
+ api_client = ApiClient.get_default()
43
+ self.api_client = api_client
44
+
45
+
46
+ @validate_call
47
+ def create_metrics(
48
+ self,
49
+ metric_request_dto: MetricRequestDTO,
50
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
51
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> BulkChangeResponseDTO:
65
+ """Create metrics
66
+
67
+ Create new simple or derived metrics. The response returns whether each metric was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
68
+
69
+ :param metric_request_dto: (required)
70
+ :type metric_request_dto: MetricRequestDTO
71
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
72
+ :type target_tenant_id: str
73
+ :param project_id: Optionally, specify a project in which to make the request.
74
+ :type project_id: str
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+
97
+ _param = self._create_metrics_serialize(
98
+ metric_request_dto=metric_request_dto,
99
+ target_tenant_id=target_tenant_id,
100
+ project_id=project_id,
101
+ _request_auth=_request_auth,
102
+ _content_type=_content_type,
103
+ _headers=_headers,
104
+ _host_index=_host_index
105
+ )
106
+
107
+ _response_types_map: Dict[str, Optional[str]] = {
108
+ '200': "BulkChangeResponseDTO",
109
+ } response_data = self.api_client.call_api(
110
+ *_param,
111
+ _request_timeout=_request_timeout
112
+ )
113
+ response_data.read()
114
+ return self.api_client.response_deserialize(
115
+ response_data=response_data,
116
+ response_types_map=_response_types_map,
117
+ ).data
118
+
119
+
120
+ @validate_call
121
+ def create_metrics_with_http_info(
122
+ self,
123
+ metric_request_dto: MetricRequestDTO,
124
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
125
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
126
+ _request_timeout: Union[
127
+ None,
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Tuple[
130
+ Annotated[StrictFloat, Field(gt=0)],
131
+ Annotated[StrictFloat, Field(gt=0)]
132
+ ]
133
+ ] = None,
134
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
135
+ _content_type: Optional[StrictStr] = None,
136
+ _headers: Optional[Dict[StrictStr, Any]] = None,
137
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
138
+ ) -> ApiResponse[BulkChangeResponseDTO]:
139
+ """Create metrics
140
+
141
+ Create new simple or derived metrics. The response returns whether each metric was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
142
+
143
+ :param metric_request_dto: (required)
144
+ :type metric_request_dto: MetricRequestDTO
145
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
146
+ :type target_tenant_id: str
147
+ :param project_id: Optionally, specify a project in which to make the request.
148
+ :type project_id: str
149
+ :param _request_timeout: timeout setting for this request. If one
150
+ number provided, it will be total request
151
+ timeout. It can also be a pair (tuple) of
152
+ (connection, read) timeouts.
153
+ :type _request_timeout: int, tuple(int, int), optional
154
+ :param _request_auth: set to override the auth_settings for an a single
155
+ request; this effectively ignores the
156
+ authentication in the spec for a single request.
157
+ :type _request_auth: dict, optional
158
+ :param _content_type: force content-type for the request.
159
+ :type _content_type: str, Optional
160
+ :param _headers: set to override the headers for a single
161
+ request; this effectively ignores the headers
162
+ in the spec for a single request.
163
+ :type _headers: dict, optional
164
+ :param _host_index: set to override the host_index for a single
165
+ request; this effectively ignores the host_index
166
+ in the spec for a single request.
167
+ :type _host_index: int, optional
168
+ :return: Returns the result object.
169
+ """ # noqa: E501
170
+
171
+ _param = self._create_metrics_serialize(
172
+ metric_request_dto=metric_request_dto,
173
+ target_tenant_id=target_tenant_id,
174
+ project_id=project_id,
175
+ _request_auth=_request_auth,
176
+ _content_type=_content_type,
177
+ _headers=_headers,
178
+ _host_index=_host_index
179
+ )
180
+
181
+ _response_types_map: Dict[str, Optional[str]] = {
182
+ '200': "BulkChangeResponseDTO",
183
+ } response_data = self.api_client.call_api(
184
+ *_param,
185
+ _request_timeout=_request_timeout
186
+ )
187
+ response_data.read()
188
+ return self.api_client.response_deserialize(
189
+ response_data=response_data,
190
+ response_types_map=_response_types_map,
191
+ )
192
+
193
+
194
+ @validate_call
195
+ def create_metrics_without_preload_content(
196
+ self,
197
+ metric_request_dto: MetricRequestDTO,
198
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
199
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
200
+ _request_timeout: Union[
201
+ None,
202
+ Annotated[StrictFloat, Field(gt=0)],
203
+ Tuple[
204
+ Annotated[StrictFloat, Field(gt=0)],
205
+ Annotated[StrictFloat, Field(gt=0)]
206
+ ]
207
+ ] = None,
208
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
209
+ _content_type: Optional[StrictStr] = None,
210
+ _headers: Optional[Dict[StrictStr, Any]] = None,
211
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
212
+ ) -> RESTResponseType:
213
+ """Create metrics
214
+
215
+ Create new simple or derived metrics. The response returns whether each metric was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
216
+
217
+ :param metric_request_dto: (required)
218
+ :type metric_request_dto: MetricRequestDTO
219
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
220
+ :type target_tenant_id: str
221
+ :param project_id: Optionally, specify a project in which to make the request.
222
+ :type project_id: str
223
+ :param _request_timeout: timeout setting for this request. If one
224
+ number provided, it will be total request
225
+ timeout. It can also be a pair (tuple) of
226
+ (connection, read) timeouts.
227
+ :type _request_timeout: int, tuple(int, int), optional
228
+ :param _request_auth: set to override the auth_settings for an a single
229
+ request; this effectively ignores the
230
+ authentication in the spec for a single request.
231
+ :type _request_auth: dict, optional
232
+ :param _content_type: force content-type for the request.
233
+ :type _content_type: str, Optional
234
+ :param _headers: set to override the headers for a single
235
+ request; this effectively ignores the headers
236
+ in the spec for a single request.
237
+ :type _headers: dict, optional
238
+ :param _host_index: set to override the host_index for a single
239
+ request; this effectively ignores the host_index
240
+ in the spec for a single request.
241
+ :type _host_index: int, optional
242
+ :return: Returns the result object.
243
+ """ # noqa: E501
244
+
245
+ _param = self._create_metrics_serialize(
246
+ metric_request_dto=metric_request_dto,
247
+ target_tenant_id=target_tenant_id,
248
+ project_id=project_id,
249
+ _request_auth=_request_auth,
250
+ _content_type=_content_type,
251
+ _headers=_headers,
252
+ _host_index=_host_index
253
+ )
254
+
255
+ _response_types_map: Dict[str, Optional[str]] = {
256
+ '200': "BulkChangeResponseDTO",
257
+ } response_data = self.api_client.call_api(
258
+ *_param,
259
+ _request_timeout=_request_timeout
260
+ )
261
+ return response_data.response
262
+
263
+
264
+ def _create_metrics_serialize(
265
+ self,
266
+ metric_request_dto,
267
+ target_tenant_id,
268
+ project_id,
269
+ _request_auth,
270
+ _content_type,
271
+ _headers,
272
+ _host_index,
273
+ ) -> RequestSerialized:
274
+
275
+ _host = None
276
+
277
+ _collection_formats: Dict[str, str] = {
278
+ }
279
+
280
+ _path_params: Dict[str, str] = {}
281
+ _query_params: List[Tuple[str, str]] = []
282
+ _header_params: Dict[str, Optional[str]] = _headers or {}
283
+ _form_params: List[Tuple[str, str]] = []
284
+ _files: Dict[
285
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
286
+ ] = {}
287
+ _body_params: Optional[bytes] = None
288
+
289
+ # process the path parameters
290
+ # process the query parameters
291
+ # process the header parameters
292
+ if target_tenant_id is not None:
293
+ _header_params['TargetTenantID'] = target_tenant_id
294
+ if project_id is not None:
295
+ _header_params['ProjectID'] = project_id
296
+ # process the form parameters
297
+ # process the body parameter
298
+ if metric_request_dto is not None:
299
+ _body_params = metric_request_dto
300
+
301
+
302
+ # set the HTTP header `Accept`
303
+ if 'Accept' not in _header_params:
304
+ _header_params['Accept'] = self.api_client.select_header_accept(
305
+ [
306
+ 'application/json'
307
+ ]
308
+ )
309
+
310
+ # set the HTTP header `Content-Type`
311
+ if _content_type:
312
+ _header_params['Content-Type'] = _content_type
313
+ else:
314
+ _default_content_type = (
315
+ self.api_client.select_header_content_type(
316
+ [
317
+ 'application/json'
318
+ ]
319
+ )
320
+ )
321
+ if _default_content_type is not None:
322
+ _header_params['Content-Type'] = _default_content_type
323
+
324
+ # authentication setting
325
+ _auth_settings: List[str] = [
326
+ 'CookieAuth',
327
+ 'ApiKeyAuth',
328
+ 'OAuth2Auth',
329
+ 'OAuth2Auth',
330
+ 'BearerAuth'
331
+ ]
332
+
333
+ return self.api_client.param_serialize(
334
+ method='POST',
335
+ resource_path='/v2alpha/data/model/metrics',
336
+ path_params=_path_params,
337
+ query_params=_query_params,
338
+ header_params=_header_params,
339
+ body=_body_params,
340
+ post_params=_form_params,
341
+ files=_files,
342
+ auth_settings=_auth_settings,
343
+ collection_formats=_collection_formats,
344
+ _host=_host,
345
+ _request_auth=_request_auth
346
+ )
347
+
348
+
349
+
350
+
351
+ @validate_call
352
+ def delete_metrics(
353
+ self,
354
+ metric_delete_request_dto: MetricDeleteRequestDTO,
355
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
356
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
357
+ _request_timeout: Union[
358
+ None,
359
+ Annotated[StrictFloat, Field(gt=0)],
360
+ Tuple[
361
+ Annotated[StrictFloat, Field(gt=0)],
362
+ Annotated[StrictFloat, Field(gt=0)]
363
+ ]
364
+ ] = None,
365
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
366
+ _content_type: Optional[StrictStr] = None,
367
+ _headers: Optional[Dict[StrictStr, Any]] = None,
368
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
369
+ ) -> BulkChangeResponseDTO:
370
+ """Delete metrics
371
+
372
+ Delete existing simple or derived metrics. The response returns whether each metric was successfully deleted or not. **Note:** Deleting a base metric will also delete any derived metrics that depend on it. Derived metrics cannot exist without their base metric. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
373
+
374
+ :param metric_delete_request_dto: (required)
375
+ :type metric_delete_request_dto: MetricDeleteRequestDTO
376
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
377
+ :type target_tenant_id: str
378
+ :param project_id: Optionally, specify a project in which to make the request.
379
+ :type project_id: str
380
+ :param _request_timeout: timeout setting for this request. If one
381
+ number provided, it will be total request
382
+ timeout. It can also be a pair (tuple) of
383
+ (connection, read) timeouts.
384
+ :type _request_timeout: int, tuple(int, int), optional
385
+ :param _request_auth: set to override the auth_settings for an a single
386
+ request; this effectively ignores the
387
+ authentication in the spec for a single request.
388
+ :type _request_auth: dict, optional
389
+ :param _content_type: force content-type for the request.
390
+ :type _content_type: str, Optional
391
+ :param _headers: set to override the headers for a single
392
+ request; this effectively ignores the headers
393
+ in the spec for a single request.
394
+ :type _headers: dict, optional
395
+ :param _host_index: set to override the host_index for a single
396
+ request; this effectively ignores the host_index
397
+ in the spec for a single request.
398
+ :type _host_index: int, optional
399
+ :return: Returns the result object.
400
+ """ # noqa: E501
401
+
402
+ _param = self._delete_metrics_serialize(
403
+ metric_delete_request_dto=metric_delete_request_dto,
404
+ target_tenant_id=target_tenant_id,
405
+ project_id=project_id,
406
+ _request_auth=_request_auth,
407
+ _content_type=_content_type,
408
+ _headers=_headers,
409
+ _host_index=_host_index
410
+ )
411
+
412
+ _response_types_map: Dict[str, Optional[str]] = {
413
+ '200': "BulkChangeResponseDTO",
414
+ } response_data = self.api_client.call_api(
415
+ *_param,
416
+ _request_timeout=_request_timeout
417
+ )
418
+ response_data.read()
419
+ return self.api_client.response_deserialize(
420
+ response_data=response_data,
421
+ response_types_map=_response_types_map,
422
+ ).data
423
+
424
+
425
+ @validate_call
426
+ def delete_metrics_with_http_info(
427
+ self,
428
+ metric_delete_request_dto: MetricDeleteRequestDTO,
429
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
430
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
431
+ _request_timeout: Union[
432
+ None,
433
+ Annotated[StrictFloat, Field(gt=0)],
434
+ Tuple[
435
+ Annotated[StrictFloat, Field(gt=0)],
436
+ Annotated[StrictFloat, Field(gt=0)]
437
+ ]
438
+ ] = None,
439
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
440
+ _content_type: Optional[StrictStr] = None,
441
+ _headers: Optional[Dict[StrictStr, Any]] = None,
442
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
443
+ ) -> ApiResponse[BulkChangeResponseDTO]:
444
+ """Delete metrics
445
+
446
+ Delete existing simple or derived metrics. The response returns whether each metric was successfully deleted or not. **Note:** Deleting a base metric will also delete any derived metrics that depend on it. Derived metrics cannot exist without their base metric. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
447
+
448
+ :param metric_delete_request_dto: (required)
449
+ :type metric_delete_request_dto: MetricDeleteRequestDTO
450
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
451
+ :type target_tenant_id: str
452
+ :param project_id: Optionally, specify a project in which to make the request.
453
+ :type project_id: str
454
+ :param _request_timeout: timeout setting for this request. If one
455
+ number provided, it will be total request
456
+ timeout. It can also be a pair (tuple) of
457
+ (connection, read) timeouts.
458
+ :type _request_timeout: int, tuple(int, int), optional
459
+ :param _request_auth: set to override the auth_settings for an a single
460
+ request; this effectively ignores the
461
+ authentication in the spec for a single request.
462
+ :type _request_auth: dict, optional
463
+ :param _content_type: force content-type for the request.
464
+ :type _content_type: str, Optional
465
+ :param _headers: set to override the headers for a single
466
+ request; this effectively ignores the headers
467
+ in the spec for a single request.
468
+ :type _headers: dict, optional
469
+ :param _host_index: set to override the host_index for a single
470
+ request; this effectively ignores the host_index
471
+ in the spec for a single request.
472
+ :type _host_index: int, optional
473
+ :return: Returns the result object.
474
+ """ # noqa: E501
475
+
476
+ _param = self._delete_metrics_serialize(
477
+ metric_delete_request_dto=metric_delete_request_dto,
478
+ target_tenant_id=target_tenant_id,
479
+ project_id=project_id,
480
+ _request_auth=_request_auth,
481
+ _content_type=_content_type,
482
+ _headers=_headers,
483
+ _host_index=_host_index
484
+ )
485
+
486
+ _response_types_map: Dict[str, Optional[str]] = {
487
+ '200': "BulkChangeResponseDTO",
488
+ } response_data = self.api_client.call_api(
489
+ *_param,
490
+ _request_timeout=_request_timeout
491
+ )
492
+ response_data.read()
493
+ return self.api_client.response_deserialize(
494
+ response_data=response_data,
495
+ response_types_map=_response_types_map,
496
+ )
497
+
498
+
499
+ @validate_call
500
+ def delete_metrics_without_preload_content(
501
+ self,
502
+ metric_delete_request_dto: MetricDeleteRequestDTO,
503
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
504
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
505
+ _request_timeout: Union[
506
+ None,
507
+ Annotated[StrictFloat, Field(gt=0)],
508
+ Tuple[
509
+ Annotated[StrictFloat, Field(gt=0)],
510
+ Annotated[StrictFloat, Field(gt=0)]
511
+ ]
512
+ ] = None,
513
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
514
+ _content_type: Optional[StrictStr] = None,
515
+ _headers: Optional[Dict[StrictStr, Any]] = None,
516
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
517
+ ) -> RESTResponseType:
518
+ """Delete metrics
519
+
520
+ Delete existing simple or derived metrics. The response returns whether each metric was successfully deleted or not. **Note:** Deleting a base metric will also delete any derived metrics that depend on it. Derived metrics cannot exist without their base metric. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
521
+
522
+ :param metric_delete_request_dto: (required)
523
+ :type metric_delete_request_dto: MetricDeleteRequestDTO
524
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
525
+ :type target_tenant_id: str
526
+ :param project_id: Optionally, specify a project in which to make the request.
527
+ :type project_id: str
528
+ :param _request_timeout: timeout setting for this request. If one
529
+ number provided, it will be total request
530
+ timeout. It can also be a pair (tuple) of
531
+ (connection, read) timeouts.
532
+ :type _request_timeout: int, tuple(int, int), optional
533
+ :param _request_auth: set to override the auth_settings for an a single
534
+ request; this effectively ignores the
535
+ authentication in the spec for a single request.
536
+ :type _request_auth: dict, optional
537
+ :param _content_type: force content-type for the request.
538
+ :type _content_type: str, Optional
539
+ :param _headers: set to override the headers for a single
540
+ request; this effectively ignores the headers
541
+ in the spec for a single request.
542
+ :type _headers: dict, optional
543
+ :param _host_index: set to override the host_index for a single
544
+ request; this effectively ignores the host_index
545
+ in the spec for a single request.
546
+ :type _host_index: int, optional
547
+ :return: Returns the result object.
548
+ """ # noqa: E501
549
+
550
+ _param = self._delete_metrics_serialize(
551
+ metric_delete_request_dto=metric_delete_request_dto,
552
+ target_tenant_id=target_tenant_id,
553
+ project_id=project_id,
554
+ _request_auth=_request_auth,
555
+ _content_type=_content_type,
556
+ _headers=_headers,
557
+ _host_index=_host_index
558
+ )
559
+
560
+ _response_types_map: Dict[str, Optional[str]] = {
561
+ '200': "BulkChangeResponseDTO",
562
+ } response_data = self.api_client.call_api(
563
+ *_param,
564
+ _request_timeout=_request_timeout
565
+ )
566
+ return response_data.response
567
+
568
+
569
+ def _delete_metrics_serialize(
570
+ self,
571
+ metric_delete_request_dto,
572
+ target_tenant_id,
573
+ project_id,
574
+ _request_auth,
575
+ _content_type,
576
+ _headers,
577
+ _host_index,
578
+ ) -> RequestSerialized:
579
+
580
+ _host = None
581
+
582
+ _collection_formats: Dict[str, str] = {
583
+ }
584
+
585
+ _path_params: Dict[str, str] = {}
586
+ _query_params: List[Tuple[str, str]] = []
587
+ _header_params: Dict[str, Optional[str]] = _headers or {}
588
+ _form_params: List[Tuple[str, str]] = []
589
+ _files: Dict[
590
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
591
+ ] = {}
592
+ _body_params: Optional[bytes] = None
593
+
594
+ # process the path parameters
595
+ # process the query parameters
596
+ # process the header parameters
597
+ if target_tenant_id is not None:
598
+ _header_params['TargetTenantID'] = target_tenant_id
599
+ if project_id is not None:
600
+ _header_params['ProjectID'] = project_id
601
+ # process the form parameters
602
+ # process the body parameter
603
+ if metric_delete_request_dto is not None:
604
+ _body_params = metric_delete_request_dto
605
+
606
+
607
+ # set the HTTP header `Accept`
608
+ if 'Accept' not in _header_params:
609
+ _header_params['Accept'] = self.api_client.select_header_accept(
610
+ [
611
+ 'application/json'
612
+ ]
613
+ )
614
+
615
+ # set the HTTP header `Content-Type`
616
+ if _content_type:
617
+ _header_params['Content-Type'] = _content_type
618
+ else:
619
+ _default_content_type = (
620
+ self.api_client.select_header_content_type(
621
+ [
622
+ 'application/json'
623
+ ]
624
+ )
625
+ )
626
+ if _default_content_type is not None:
627
+ _header_params['Content-Type'] = _default_content_type
628
+
629
+ # authentication setting
630
+ _auth_settings: List[str] = [
631
+ 'CookieAuth',
632
+ 'ApiKeyAuth',
633
+ 'OAuth2Auth',
634
+ 'OAuth2Auth',
635
+ 'BearerAuth'
636
+ ]
637
+
638
+ return self.api_client.param_serialize(
639
+ method='DELETE',
640
+ resource_path='/v2alpha/data/model/metrics',
641
+ path_params=_path_params,
642
+ query_params=_query_params,
643
+ header_params=_header_params,
644
+ body=_body_params,
645
+ post_params=_form_params,
646
+ files=_files,
647
+ auth_settings=_auth_settings,
648
+ collection_formats=_collection_formats,
649
+ _host=_host,
650
+ _request_auth=_request_auth
651
+ )
652
+
653
+
654
+
655
+
656
+ @validate_call
657
+ def get_all_metrics(
658
+ self,
659
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
660
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
661
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
662
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
663
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
664
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
665
+ _request_timeout: Union[
666
+ None,
667
+ Annotated[StrictFloat, Field(gt=0)],
668
+ Tuple[
669
+ Annotated[StrictFloat, Field(gt=0)],
670
+ Annotated[StrictFloat, Field(gt=0)]
671
+ ]
672
+ ] = None,
673
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
674
+ _content_type: Optional[StrictStr] = None,
675
+ _headers: Optional[Dict[StrictStr, Any]] = None,
676
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
677
+ ) -> MetricResponseDTO:
678
+ """Retrieve a list of metrics
679
+
680
+ Retrieve a list of all simple or derived metrics in your Visier tenant. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
681
+
682
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
683
+ :type type: List[str]
684
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
685
+ :type var_with: List[str]
686
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
687
+ :type object_name: List[str]
688
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
689
+ :type uuid: List[str]
690
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
691
+ :type target_tenant_id: str
692
+ :param project_id: Optionally, specify a project in which to make the request.
693
+ :type project_id: str
694
+ :param _request_timeout: timeout setting for this request. If one
695
+ number provided, it will be total request
696
+ timeout. It can also be a pair (tuple) of
697
+ (connection, read) timeouts.
698
+ :type _request_timeout: int, tuple(int, int), optional
699
+ :param _request_auth: set to override the auth_settings for an a single
700
+ request; this effectively ignores the
701
+ authentication in the spec for a single request.
702
+ :type _request_auth: dict, optional
703
+ :param _content_type: force content-type for the request.
704
+ :type _content_type: str, Optional
705
+ :param _headers: set to override the headers for a single
706
+ request; this effectively ignores the headers
707
+ in the spec for a single request.
708
+ :type _headers: dict, optional
709
+ :param _host_index: set to override the host_index for a single
710
+ request; this effectively ignores the host_index
711
+ in the spec for a single request.
712
+ :type _host_index: int, optional
713
+ :return: Returns the result object.
714
+ """ # noqa: E501
715
+
716
+ _param = self._get_all_metrics_serialize(
717
+ type=type,
718
+ var_with=var_with,
719
+ object_name=object_name,
720
+ uuid=uuid,
721
+ target_tenant_id=target_tenant_id,
722
+ project_id=project_id,
723
+ _request_auth=_request_auth,
724
+ _content_type=_content_type,
725
+ _headers=_headers,
726
+ _host_index=_host_index
727
+ )
728
+
729
+ _response_types_map: Dict[str, Optional[str]] = {
730
+ '200': "MetricResponseDTO",
731
+ } response_data = self.api_client.call_api(
732
+ *_param,
733
+ _request_timeout=_request_timeout
734
+ )
735
+ response_data.read()
736
+ return self.api_client.response_deserialize(
737
+ response_data=response_data,
738
+ response_types_map=_response_types_map,
739
+ ).data
740
+
741
+
742
+ @validate_call
743
+ def get_all_metrics_with_http_info(
744
+ self,
745
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
746
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
747
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
748
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
749
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
750
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
751
+ _request_timeout: Union[
752
+ None,
753
+ Annotated[StrictFloat, Field(gt=0)],
754
+ Tuple[
755
+ Annotated[StrictFloat, Field(gt=0)],
756
+ Annotated[StrictFloat, Field(gt=0)]
757
+ ]
758
+ ] = None,
759
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
760
+ _content_type: Optional[StrictStr] = None,
761
+ _headers: Optional[Dict[StrictStr, Any]] = None,
762
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
763
+ ) -> ApiResponse[MetricResponseDTO]:
764
+ """Retrieve a list of metrics
765
+
766
+ Retrieve a list of all simple or derived metrics in your Visier tenant. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
767
+
768
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
769
+ :type type: List[str]
770
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
771
+ :type var_with: List[str]
772
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
773
+ :type object_name: List[str]
774
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
775
+ :type uuid: List[str]
776
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
777
+ :type target_tenant_id: str
778
+ :param project_id: Optionally, specify a project in which to make the request.
779
+ :type project_id: str
780
+ :param _request_timeout: timeout setting for this request. If one
781
+ number provided, it will be total request
782
+ timeout. It can also be a pair (tuple) of
783
+ (connection, read) timeouts.
784
+ :type _request_timeout: int, tuple(int, int), optional
785
+ :param _request_auth: set to override the auth_settings for an a single
786
+ request; this effectively ignores the
787
+ authentication in the spec for a single request.
788
+ :type _request_auth: dict, optional
789
+ :param _content_type: force content-type for the request.
790
+ :type _content_type: str, Optional
791
+ :param _headers: set to override the headers for a single
792
+ request; this effectively ignores the headers
793
+ in the spec for a single request.
794
+ :type _headers: dict, optional
795
+ :param _host_index: set to override the host_index for a single
796
+ request; this effectively ignores the host_index
797
+ in the spec for a single request.
798
+ :type _host_index: int, optional
799
+ :return: Returns the result object.
800
+ """ # noqa: E501
801
+
802
+ _param = self._get_all_metrics_serialize(
803
+ type=type,
804
+ var_with=var_with,
805
+ object_name=object_name,
806
+ uuid=uuid,
807
+ target_tenant_id=target_tenant_id,
808
+ project_id=project_id,
809
+ _request_auth=_request_auth,
810
+ _content_type=_content_type,
811
+ _headers=_headers,
812
+ _host_index=_host_index
813
+ )
814
+
815
+ _response_types_map: Dict[str, Optional[str]] = {
816
+ '200': "MetricResponseDTO",
817
+ } response_data = self.api_client.call_api(
818
+ *_param,
819
+ _request_timeout=_request_timeout
820
+ )
821
+ response_data.read()
822
+ return self.api_client.response_deserialize(
823
+ response_data=response_data,
824
+ response_types_map=_response_types_map,
825
+ )
826
+
827
+
828
+ @validate_call
829
+ def get_all_metrics_without_preload_content(
830
+ self,
831
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
832
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
833
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
834
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
835
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
836
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
837
+ _request_timeout: Union[
838
+ None,
839
+ Annotated[StrictFloat, Field(gt=0)],
840
+ Tuple[
841
+ Annotated[StrictFloat, Field(gt=0)],
842
+ Annotated[StrictFloat, Field(gt=0)]
843
+ ]
844
+ ] = None,
845
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
846
+ _content_type: Optional[StrictStr] = None,
847
+ _headers: Optional[Dict[StrictStr, Any]] = None,
848
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
849
+ ) -> RESTResponseType:
850
+ """Retrieve a list of metrics
851
+
852
+ Retrieve a list of all simple or derived metrics in your Visier tenant. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
853
+
854
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
855
+ :type type: List[str]
856
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
857
+ :type var_with: List[str]
858
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
859
+ :type object_name: List[str]
860
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
861
+ :type uuid: List[str]
862
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
863
+ :type target_tenant_id: str
864
+ :param project_id: Optionally, specify a project in which to make the request.
865
+ :type project_id: str
866
+ :param _request_timeout: timeout setting for this request. If one
867
+ number provided, it will be total request
868
+ timeout. It can also be a pair (tuple) of
869
+ (connection, read) timeouts.
870
+ :type _request_timeout: int, tuple(int, int), optional
871
+ :param _request_auth: set to override the auth_settings for an a single
872
+ request; this effectively ignores the
873
+ authentication in the spec for a single request.
874
+ :type _request_auth: dict, optional
875
+ :param _content_type: force content-type for the request.
876
+ :type _content_type: str, Optional
877
+ :param _headers: set to override the headers for a single
878
+ request; this effectively ignores the headers
879
+ in the spec for a single request.
880
+ :type _headers: dict, optional
881
+ :param _host_index: set to override the host_index for a single
882
+ request; this effectively ignores the host_index
883
+ in the spec for a single request.
884
+ :type _host_index: int, optional
885
+ :return: Returns the result object.
886
+ """ # noqa: E501
887
+
888
+ _param = self._get_all_metrics_serialize(
889
+ type=type,
890
+ var_with=var_with,
891
+ object_name=object_name,
892
+ uuid=uuid,
893
+ target_tenant_id=target_tenant_id,
894
+ project_id=project_id,
895
+ _request_auth=_request_auth,
896
+ _content_type=_content_type,
897
+ _headers=_headers,
898
+ _host_index=_host_index
899
+ )
900
+
901
+ _response_types_map: Dict[str, Optional[str]] = {
902
+ '200': "MetricResponseDTO",
903
+ } response_data = self.api_client.call_api(
904
+ *_param,
905
+ _request_timeout=_request_timeout
906
+ )
907
+ return response_data.response
908
+
909
+
910
+ def _get_all_metrics_serialize(
911
+ self,
912
+ type,
913
+ var_with,
914
+ object_name,
915
+ uuid,
916
+ target_tenant_id,
917
+ project_id,
918
+ _request_auth,
919
+ _content_type,
920
+ _headers,
921
+ _host_index,
922
+ ) -> RequestSerialized:
923
+
924
+ _host = None
925
+
926
+ _collection_formats: Dict[str, str] = {
927
+ 'type': 'multi',
928
+ 'with': 'multi',
929
+ 'objectName': 'multi',
930
+ 'uuid': 'multi',
931
+ }
932
+
933
+ _path_params: Dict[str, str] = {}
934
+ _query_params: List[Tuple[str, str]] = []
935
+ _header_params: Dict[str, Optional[str]] = _headers or {}
936
+ _form_params: List[Tuple[str, str]] = []
937
+ _files: Dict[
938
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
939
+ ] = {}
940
+ _body_params: Optional[bytes] = None
941
+
942
+ # process the path parameters
943
+ # process the query parameters
944
+ if type is not None:
945
+
946
+ _query_params.append(('type', type))
947
+
948
+ if var_with is not None:
949
+
950
+ _query_params.append(('with', var_with))
951
+
952
+ if object_name is not None:
953
+
954
+ _query_params.append(('objectName', object_name))
955
+
956
+ if uuid is not None:
957
+
958
+ _query_params.append(('uuid', uuid))
959
+
960
+ # process the header parameters
961
+ if target_tenant_id is not None:
962
+ _header_params['TargetTenantID'] = target_tenant_id
963
+ if project_id is not None:
964
+ _header_params['ProjectID'] = project_id
965
+ # process the form parameters
966
+ # process the body parameter
967
+
968
+
969
+ # set the HTTP header `Accept`
970
+ if 'Accept' not in _header_params:
971
+ _header_params['Accept'] = self.api_client.select_header_accept(
972
+ [
973
+ 'application/json'
974
+ ]
975
+ )
976
+
977
+
978
+ # authentication setting
979
+ _auth_settings: List[str] = [
980
+ 'CookieAuth',
981
+ 'ApiKeyAuth',
982
+ 'OAuth2Auth',
983
+ 'OAuth2Auth',
984
+ 'BearerAuth'
985
+ ]
986
+
987
+ return self.api_client.param_serialize(
988
+ method='GET',
989
+ resource_path='/v2alpha/data/model/metrics',
990
+ path_params=_path_params,
991
+ query_params=_query_params,
992
+ header_params=_header_params,
993
+ body=_body_params,
994
+ post_params=_form_params,
995
+ files=_files,
996
+ auth_settings=_auth_settings,
997
+ collection_formats=_collection_formats,
998
+ _host=_host,
999
+ _request_auth=_request_auth
1000
+ )
1001
+
1002
+
1003
+
1004
+
1005
+ @validate_call
1006
+ def get_analytic_object_metrics(
1007
+ self,
1008
+ analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve metrics.")],
1009
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
1010
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1011
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1012
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1013
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1014
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1015
+ _request_timeout: Union[
1016
+ None,
1017
+ Annotated[StrictFloat, Field(gt=0)],
1018
+ Tuple[
1019
+ Annotated[StrictFloat, Field(gt=0)],
1020
+ Annotated[StrictFloat, Field(gt=0)]
1021
+ ]
1022
+ ] = None,
1023
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1024
+ _content_type: Optional[StrictStr] = None,
1025
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1026
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1027
+ ) -> MetricResponseDTO:
1028
+ """Retrieve a list of metrics by analytic object
1029
+
1030
+ Retrieve all the simple or derived metrics for a specific analytic object. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1031
+
1032
+ :param analytic_object_name: The object name of the analytic object from which to retrieve metrics. (required)
1033
+ :type analytic_object_name: str
1034
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
1035
+ :type type: List[str]
1036
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
1037
+ :type var_with: List[str]
1038
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
1039
+ :type object_name: List[str]
1040
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
1041
+ :type uuid: List[str]
1042
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1043
+ :type target_tenant_id: str
1044
+ :param project_id: Optionally, specify a project in which to make the request.
1045
+ :type project_id: str
1046
+ :param _request_timeout: timeout setting for this request. If one
1047
+ number provided, it will be total request
1048
+ timeout. It can also be a pair (tuple) of
1049
+ (connection, read) timeouts.
1050
+ :type _request_timeout: int, tuple(int, int), optional
1051
+ :param _request_auth: set to override the auth_settings for an a single
1052
+ request; this effectively ignores the
1053
+ authentication in the spec for a single request.
1054
+ :type _request_auth: dict, optional
1055
+ :param _content_type: force content-type for the request.
1056
+ :type _content_type: str, Optional
1057
+ :param _headers: set to override the headers for a single
1058
+ request; this effectively ignores the headers
1059
+ in the spec for a single request.
1060
+ :type _headers: dict, optional
1061
+ :param _host_index: set to override the host_index for a single
1062
+ request; this effectively ignores the host_index
1063
+ in the spec for a single request.
1064
+ :type _host_index: int, optional
1065
+ :return: Returns the result object.
1066
+ """ # noqa: E501
1067
+
1068
+ _param = self._get_analytic_object_metrics_serialize(
1069
+ analytic_object_name=analytic_object_name,
1070
+ type=type,
1071
+ var_with=var_with,
1072
+ object_name=object_name,
1073
+ uuid=uuid,
1074
+ target_tenant_id=target_tenant_id,
1075
+ project_id=project_id,
1076
+ _request_auth=_request_auth,
1077
+ _content_type=_content_type,
1078
+ _headers=_headers,
1079
+ _host_index=_host_index
1080
+ )
1081
+
1082
+ _response_types_map: Dict[str, Optional[str]] = {
1083
+ '200': "MetricResponseDTO",
1084
+ } response_data = self.api_client.call_api(
1085
+ *_param,
1086
+ _request_timeout=_request_timeout
1087
+ )
1088
+ response_data.read()
1089
+ return self.api_client.response_deserialize(
1090
+ response_data=response_data,
1091
+ response_types_map=_response_types_map,
1092
+ ).data
1093
+
1094
+
1095
+ @validate_call
1096
+ def get_analytic_object_metrics_with_http_info(
1097
+ self,
1098
+ analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve metrics.")],
1099
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
1100
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1101
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1102
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1103
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1104
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1105
+ _request_timeout: Union[
1106
+ None,
1107
+ Annotated[StrictFloat, Field(gt=0)],
1108
+ Tuple[
1109
+ Annotated[StrictFloat, Field(gt=0)],
1110
+ Annotated[StrictFloat, Field(gt=0)]
1111
+ ]
1112
+ ] = None,
1113
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1114
+ _content_type: Optional[StrictStr] = None,
1115
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1116
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1117
+ ) -> ApiResponse[MetricResponseDTO]:
1118
+ """Retrieve a list of metrics by analytic object
1119
+
1120
+ Retrieve all the simple or derived metrics for a specific analytic object. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1121
+
1122
+ :param analytic_object_name: The object name of the analytic object from which to retrieve metrics. (required)
1123
+ :type analytic_object_name: str
1124
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
1125
+ :type type: List[str]
1126
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
1127
+ :type var_with: List[str]
1128
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
1129
+ :type object_name: List[str]
1130
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
1131
+ :type uuid: List[str]
1132
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1133
+ :type target_tenant_id: str
1134
+ :param project_id: Optionally, specify a project in which to make the request.
1135
+ :type project_id: str
1136
+ :param _request_timeout: timeout setting for this request. If one
1137
+ number provided, it will be total request
1138
+ timeout. It can also be a pair (tuple) of
1139
+ (connection, read) timeouts.
1140
+ :type _request_timeout: int, tuple(int, int), optional
1141
+ :param _request_auth: set to override the auth_settings for an a single
1142
+ request; this effectively ignores the
1143
+ authentication in the spec for a single request.
1144
+ :type _request_auth: dict, optional
1145
+ :param _content_type: force content-type for the request.
1146
+ :type _content_type: str, Optional
1147
+ :param _headers: set to override the headers for a single
1148
+ request; this effectively ignores the headers
1149
+ in the spec for a single request.
1150
+ :type _headers: dict, optional
1151
+ :param _host_index: set to override the host_index for a single
1152
+ request; this effectively ignores the host_index
1153
+ in the spec for a single request.
1154
+ :type _host_index: int, optional
1155
+ :return: Returns the result object.
1156
+ """ # noqa: E501
1157
+
1158
+ _param = self._get_analytic_object_metrics_serialize(
1159
+ analytic_object_name=analytic_object_name,
1160
+ type=type,
1161
+ var_with=var_with,
1162
+ object_name=object_name,
1163
+ uuid=uuid,
1164
+ target_tenant_id=target_tenant_id,
1165
+ project_id=project_id,
1166
+ _request_auth=_request_auth,
1167
+ _content_type=_content_type,
1168
+ _headers=_headers,
1169
+ _host_index=_host_index
1170
+ )
1171
+
1172
+ _response_types_map: Dict[str, Optional[str]] = {
1173
+ '200': "MetricResponseDTO",
1174
+ } response_data = self.api_client.call_api(
1175
+ *_param,
1176
+ _request_timeout=_request_timeout
1177
+ )
1178
+ response_data.read()
1179
+ return self.api_client.response_deserialize(
1180
+ response_data=response_data,
1181
+ response_types_map=_response_types_map,
1182
+ )
1183
+
1184
+
1185
+ @validate_call
1186
+ def get_analytic_object_metrics_without_preload_content(
1187
+ self,
1188
+ analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve metrics.")],
1189
+ type: Annotated[Optional[List[StrictStr]], Field(description="The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.")] = None,
1190
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1191
+ object_name: Annotated[Optional[List[StrictStr]], Field(description="The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1192
+ uuid: Annotated[Optional[List[StrictStr]], Field(description="The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None,
1193
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1194
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1195
+ _request_timeout: Union[
1196
+ None,
1197
+ Annotated[StrictFloat, Field(gt=0)],
1198
+ Tuple[
1199
+ Annotated[StrictFloat, Field(gt=0)],
1200
+ Annotated[StrictFloat, Field(gt=0)]
1201
+ ]
1202
+ ] = None,
1203
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1204
+ _content_type: Optional[StrictStr] = None,
1205
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1206
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1207
+ ) -> RESTResponseType:
1208
+ """Retrieve a list of metrics by analytic object
1209
+
1210
+ Retrieve all the simple or derived metrics for a specific analytic object. By default, the response will return the `basic` representation of the metric definitions. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1211
+
1212
+ :param analytic_object_name: The object name of the analytic object from which to retrieve metrics. (required)
1213
+ :type analytic_object_name: str
1214
+ :param type: The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values: - `simple`: Retrieves all simple metrics. - `derived`: Retrieves all derived metrics.
1215
+ :type type: List[str]
1216
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. - `version`: Retrieves the object's version information, such as version type and last edited details.
1217
+ :type var_with: List[str]
1218
+ :param object_name: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
1219
+ :type object_name: List[str]
1220
+ :param uuid: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
1221
+ :type uuid: List[str]
1222
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1223
+ :type target_tenant_id: str
1224
+ :param project_id: Optionally, specify a project in which to make the request.
1225
+ :type project_id: str
1226
+ :param _request_timeout: timeout setting for this request. If one
1227
+ number provided, it will be total request
1228
+ timeout. It can also be a pair (tuple) of
1229
+ (connection, read) timeouts.
1230
+ :type _request_timeout: int, tuple(int, int), optional
1231
+ :param _request_auth: set to override the auth_settings for an a single
1232
+ request; this effectively ignores the
1233
+ authentication in the spec for a single request.
1234
+ :type _request_auth: dict, optional
1235
+ :param _content_type: force content-type for the request.
1236
+ :type _content_type: str, Optional
1237
+ :param _headers: set to override the headers for a single
1238
+ request; this effectively ignores the headers
1239
+ in the spec for a single request.
1240
+ :type _headers: dict, optional
1241
+ :param _host_index: set to override the host_index for a single
1242
+ request; this effectively ignores the host_index
1243
+ in the spec for a single request.
1244
+ :type _host_index: int, optional
1245
+ :return: Returns the result object.
1246
+ """ # noqa: E501
1247
+
1248
+ _param = self._get_analytic_object_metrics_serialize(
1249
+ analytic_object_name=analytic_object_name,
1250
+ type=type,
1251
+ var_with=var_with,
1252
+ object_name=object_name,
1253
+ uuid=uuid,
1254
+ target_tenant_id=target_tenant_id,
1255
+ project_id=project_id,
1256
+ _request_auth=_request_auth,
1257
+ _content_type=_content_type,
1258
+ _headers=_headers,
1259
+ _host_index=_host_index
1260
+ )
1261
+
1262
+ _response_types_map: Dict[str, Optional[str]] = {
1263
+ '200': "MetricResponseDTO",
1264
+ } response_data = self.api_client.call_api(
1265
+ *_param,
1266
+ _request_timeout=_request_timeout
1267
+ )
1268
+ return response_data.response
1269
+
1270
+
1271
+ def _get_analytic_object_metrics_serialize(
1272
+ self,
1273
+ analytic_object_name,
1274
+ type,
1275
+ var_with,
1276
+ object_name,
1277
+ uuid,
1278
+ target_tenant_id,
1279
+ project_id,
1280
+ _request_auth,
1281
+ _content_type,
1282
+ _headers,
1283
+ _host_index,
1284
+ ) -> RequestSerialized:
1285
+
1286
+ _host = None
1287
+
1288
+ _collection_formats: Dict[str, str] = {
1289
+ 'type': 'multi',
1290
+ 'with': 'multi',
1291
+ 'objectName': 'multi',
1292
+ 'uuid': 'multi',
1293
+ }
1294
+
1295
+ _path_params: Dict[str, str] = {}
1296
+ _query_params: List[Tuple[str, str]] = []
1297
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1298
+ _form_params: List[Tuple[str, str]] = []
1299
+ _files: Dict[
1300
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1301
+ ] = {}
1302
+ _body_params: Optional[bytes] = None
1303
+
1304
+ # process the path parameters
1305
+ if analytic_object_name is not None:
1306
+ _path_params['analyticObjectName'] = analytic_object_name
1307
+ # process the query parameters
1308
+ if type is not None:
1309
+
1310
+ _query_params.append(('type', type))
1311
+
1312
+ if var_with is not None:
1313
+
1314
+ _query_params.append(('with', var_with))
1315
+
1316
+ if object_name is not None:
1317
+
1318
+ _query_params.append(('objectName', object_name))
1319
+
1320
+ if uuid is not None:
1321
+
1322
+ _query_params.append(('uuid', uuid))
1323
+
1324
+ # process the header parameters
1325
+ if target_tenant_id is not None:
1326
+ _header_params['TargetTenantID'] = target_tenant_id
1327
+ if project_id is not None:
1328
+ _header_params['ProjectID'] = project_id
1329
+ # process the form parameters
1330
+ # process the body parameter
1331
+
1332
+
1333
+ # set the HTTP header `Accept`
1334
+ if 'Accept' not in _header_params:
1335
+ _header_params['Accept'] = self.api_client.select_header_accept(
1336
+ [
1337
+ 'application/json'
1338
+ ]
1339
+ )
1340
+
1341
+
1342
+ # authentication setting
1343
+ _auth_settings: List[str] = [
1344
+ 'CookieAuth',
1345
+ 'ApiKeyAuth',
1346
+ 'OAuth2Auth',
1347
+ 'OAuth2Auth',
1348
+ 'BearerAuth'
1349
+ ]
1350
+
1351
+ return self.api_client.param_serialize(
1352
+ method='GET',
1353
+ resource_path='/v2alpha/data/model/analytic-objects/{analyticObjectName}/metrics',
1354
+ path_params=_path_params,
1355
+ query_params=_query_params,
1356
+ header_params=_header_params,
1357
+ body=_body_params,
1358
+ post_params=_form_params,
1359
+ files=_files,
1360
+ auth_settings=_auth_settings,
1361
+ collection_formats=_collection_formats,
1362
+ _host=_host,
1363
+ _request_auth=_request_auth
1364
+ )
1365
+
1366
+
1367
+
1368
+
1369
+ @validate_call
1370
+ def get_one_metric(
1371
+ self,
1372
+ metric_id: Annotated[StrictStr, Field(description="The object name or UUID of the metric to retrieve.")],
1373
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1374
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1375
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1376
+ _request_timeout: Union[
1377
+ None,
1378
+ Annotated[StrictFloat, Field(gt=0)],
1379
+ Tuple[
1380
+ Annotated[StrictFloat, Field(gt=0)],
1381
+ Annotated[StrictFloat, Field(gt=0)]
1382
+ ]
1383
+ ] = None,
1384
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1385
+ _content_type: Optional[StrictStr] = None,
1386
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1387
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1388
+ ) -> MetricResponseDTO:
1389
+ """Retrieve a metric's details
1390
+
1391
+ Retrieve the details of a specific simple or derived metric, such as its metric type and description. By default, the response will return the detailed representation of the metric definition. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1392
+
1393
+ :param metric_id: The object name or UUID of the metric to retrieve. (required)
1394
+ :type metric_id: str
1395
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.
1396
+ :type var_with: List[str]
1397
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1398
+ :type target_tenant_id: str
1399
+ :param project_id: Optionally, specify a project in which to make the request.
1400
+ :type project_id: str
1401
+ :param _request_timeout: timeout setting for this request. If one
1402
+ number provided, it will be total request
1403
+ timeout. It can also be a pair (tuple) of
1404
+ (connection, read) timeouts.
1405
+ :type _request_timeout: int, tuple(int, int), optional
1406
+ :param _request_auth: set to override the auth_settings for an a single
1407
+ request; this effectively ignores the
1408
+ authentication in the spec for a single request.
1409
+ :type _request_auth: dict, optional
1410
+ :param _content_type: force content-type for the request.
1411
+ :type _content_type: str, Optional
1412
+ :param _headers: set to override the headers for a single
1413
+ request; this effectively ignores the headers
1414
+ in the spec for a single request.
1415
+ :type _headers: dict, optional
1416
+ :param _host_index: set to override the host_index for a single
1417
+ request; this effectively ignores the host_index
1418
+ in the spec for a single request.
1419
+ :type _host_index: int, optional
1420
+ :return: Returns the result object.
1421
+ """ # noqa: E501
1422
+
1423
+ _param = self._get_one_metric_serialize(
1424
+ metric_id=metric_id,
1425
+ var_with=var_with,
1426
+ target_tenant_id=target_tenant_id,
1427
+ project_id=project_id,
1428
+ _request_auth=_request_auth,
1429
+ _content_type=_content_type,
1430
+ _headers=_headers,
1431
+ _host_index=_host_index
1432
+ )
1433
+
1434
+ _response_types_map: Dict[str, Optional[str]] = {
1435
+ '200': "MetricResponseDTO",
1436
+ } response_data = self.api_client.call_api(
1437
+ *_param,
1438
+ _request_timeout=_request_timeout
1439
+ )
1440
+ response_data.read()
1441
+ return self.api_client.response_deserialize(
1442
+ response_data=response_data,
1443
+ response_types_map=_response_types_map,
1444
+ ).data
1445
+
1446
+
1447
+ @validate_call
1448
+ def get_one_metric_with_http_info(
1449
+ self,
1450
+ metric_id: Annotated[StrictStr, Field(description="The object name or UUID of the metric to retrieve.")],
1451
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1452
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1453
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1454
+ _request_timeout: Union[
1455
+ None,
1456
+ Annotated[StrictFloat, Field(gt=0)],
1457
+ Tuple[
1458
+ Annotated[StrictFloat, Field(gt=0)],
1459
+ Annotated[StrictFloat, Field(gt=0)]
1460
+ ]
1461
+ ] = None,
1462
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1463
+ _content_type: Optional[StrictStr] = None,
1464
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1465
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1466
+ ) -> ApiResponse[MetricResponseDTO]:
1467
+ """Retrieve a metric's details
1468
+
1469
+ Retrieve the details of a specific simple or derived metric, such as its metric type and description. By default, the response will return the detailed representation of the metric definition. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1470
+
1471
+ :param metric_id: The object name or UUID of the metric to retrieve. (required)
1472
+ :type metric_id: str
1473
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.
1474
+ :type var_with: List[str]
1475
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1476
+ :type target_tenant_id: str
1477
+ :param project_id: Optionally, specify a project in which to make the request.
1478
+ :type project_id: str
1479
+ :param _request_timeout: timeout setting for this request. If one
1480
+ number provided, it will be total request
1481
+ timeout. It can also be a pair (tuple) of
1482
+ (connection, read) timeouts.
1483
+ :type _request_timeout: int, tuple(int, int), optional
1484
+ :param _request_auth: set to override the auth_settings for an a single
1485
+ request; this effectively ignores the
1486
+ authentication in the spec for a single request.
1487
+ :type _request_auth: dict, optional
1488
+ :param _content_type: force content-type for the request.
1489
+ :type _content_type: str, Optional
1490
+ :param _headers: set to override the headers for a single
1491
+ request; this effectively ignores the headers
1492
+ in the spec for a single request.
1493
+ :type _headers: dict, optional
1494
+ :param _host_index: set to override the host_index for a single
1495
+ request; this effectively ignores the host_index
1496
+ in the spec for a single request.
1497
+ :type _host_index: int, optional
1498
+ :return: Returns the result object.
1499
+ """ # noqa: E501
1500
+
1501
+ _param = self._get_one_metric_serialize(
1502
+ metric_id=metric_id,
1503
+ var_with=var_with,
1504
+ target_tenant_id=target_tenant_id,
1505
+ project_id=project_id,
1506
+ _request_auth=_request_auth,
1507
+ _content_type=_content_type,
1508
+ _headers=_headers,
1509
+ _host_index=_host_index
1510
+ )
1511
+
1512
+ _response_types_map: Dict[str, Optional[str]] = {
1513
+ '200': "MetricResponseDTO",
1514
+ } response_data = self.api_client.call_api(
1515
+ *_param,
1516
+ _request_timeout=_request_timeout
1517
+ )
1518
+ response_data.read()
1519
+ return self.api_client.response_deserialize(
1520
+ response_data=response_data,
1521
+ response_types_map=_response_types_map,
1522
+ )
1523
+
1524
+
1525
+ @validate_call
1526
+ def get_one_metric_without_preload_content(
1527
+ self,
1528
+ metric_id: Annotated[StrictStr, Field(description="The object name or UUID of the metric to retrieve.")],
1529
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.")] = None,
1530
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1531
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1532
+ _request_timeout: Union[
1533
+ None,
1534
+ Annotated[StrictFloat, Field(gt=0)],
1535
+ Tuple[
1536
+ Annotated[StrictFloat, Field(gt=0)],
1537
+ Annotated[StrictFloat, Field(gt=0)]
1538
+ ]
1539
+ ] = None,
1540
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1541
+ _content_type: Optional[StrictStr] = None,
1542
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1543
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1544
+ ) -> RESTResponseType:
1545
+ """Retrieve a metric's details
1546
+
1547
+ Retrieve the details of a specific simple or derived metric, such as its metric type and description. By default, the response will return the detailed representation of the metric definition. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1548
+
1549
+ :param metric_id: The object name or UUID of the metric to retrieve. (required)
1550
+ :type metric_id: str
1551
+ :param var_with: The level of information to retrieve for the metric. Valid values: - `basic`: Retrieves the metric's UUID, object name, and basic information. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default. - `version`: Retrieves the object's version information, such as version type and last edited details.
1552
+ :type var_with: List[str]
1553
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1554
+ :type target_tenant_id: str
1555
+ :param project_id: Optionally, specify a project in which to make the request.
1556
+ :type project_id: str
1557
+ :param _request_timeout: timeout setting for this request. If one
1558
+ number provided, it will be total request
1559
+ timeout. It can also be a pair (tuple) of
1560
+ (connection, read) timeouts.
1561
+ :type _request_timeout: int, tuple(int, int), optional
1562
+ :param _request_auth: set to override the auth_settings for an a single
1563
+ request; this effectively ignores the
1564
+ authentication in the spec for a single request.
1565
+ :type _request_auth: dict, optional
1566
+ :param _content_type: force content-type for the request.
1567
+ :type _content_type: str, Optional
1568
+ :param _headers: set to override the headers for a single
1569
+ request; this effectively ignores the headers
1570
+ in the spec for a single request.
1571
+ :type _headers: dict, optional
1572
+ :param _host_index: set to override the host_index for a single
1573
+ request; this effectively ignores the host_index
1574
+ in the spec for a single request.
1575
+ :type _host_index: int, optional
1576
+ :return: Returns the result object.
1577
+ """ # noqa: E501
1578
+
1579
+ _param = self._get_one_metric_serialize(
1580
+ metric_id=metric_id,
1581
+ var_with=var_with,
1582
+ target_tenant_id=target_tenant_id,
1583
+ project_id=project_id,
1584
+ _request_auth=_request_auth,
1585
+ _content_type=_content_type,
1586
+ _headers=_headers,
1587
+ _host_index=_host_index
1588
+ )
1589
+
1590
+ _response_types_map: Dict[str, Optional[str]] = {
1591
+ '200': "MetricResponseDTO",
1592
+ } response_data = self.api_client.call_api(
1593
+ *_param,
1594
+ _request_timeout=_request_timeout
1595
+ )
1596
+ return response_data.response
1597
+
1598
+
1599
+ def _get_one_metric_serialize(
1600
+ self,
1601
+ metric_id,
1602
+ var_with,
1603
+ target_tenant_id,
1604
+ project_id,
1605
+ _request_auth,
1606
+ _content_type,
1607
+ _headers,
1608
+ _host_index,
1609
+ ) -> RequestSerialized:
1610
+
1611
+ _host = None
1612
+
1613
+ _collection_formats: Dict[str, str] = {
1614
+ 'with': 'multi',
1615
+ }
1616
+
1617
+ _path_params: Dict[str, str] = {}
1618
+ _query_params: List[Tuple[str, str]] = []
1619
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1620
+ _form_params: List[Tuple[str, str]] = []
1621
+ _files: Dict[
1622
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1623
+ ] = {}
1624
+ _body_params: Optional[bytes] = None
1625
+
1626
+ # process the path parameters
1627
+ if metric_id is not None:
1628
+ _path_params['metricId'] = metric_id
1629
+ # process the query parameters
1630
+ if var_with is not None:
1631
+
1632
+ _query_params.append(('with', var_with))
1633
+
1634
+ # process the header parameters
1635
+ if target_tenant_id is not None:
1636
+ _header_params['TargetTenantID'] = target_tenant_id
1637
+ if project_id is not None:
1638
+ _header_params['ProjectID'] = project_id
1639
+ # process the form parameters
1640
+ # process the body parameter
1641
+
1642
+
1643
+ # set the HTTP header `Accept`
1644
+ if 'Accept' not in _header_params:
1645
+ _header_params['Accept'] = self.api_client.select_header_accept(
1646
+ [
1647
+ 'application/json'
1648
+ ]
1649
+ )
1650
+
1651
+
1652
+ # authentication setting
1653
+ _auth_settings: List[str] = [
1654
+ 'CookieAuth',
1655
+ 'ApiKeyAuth',
1656
+ 'OAuth2Auth',
1657
+ 'OAuth2Auth',
1658
+ 'BearerAuth'
1659
+ ]
1660
+
1661
+ return self.api_client.param_serialize(
1662
+ method='GET',
1663
+ resource_path='/v2alpha/data/model/metrics/{metricId}',
1664
+ path_params=_path_params,
1665
+ query_params=_query_params,
1666
+ header_params=_header_params,
1667
+ body=_body_params,
1668
+ post_params=_form_params,
1669
+ files=_files,
1670
+ auth_settings=_auth_settings,
1671
+ collection_formats=_collection_formats,
1672
+ _host=_host,
1673
+ _request_auth=_request_auth
1674
+ )
1675
+
1676
+
1677
+
1678
+
1679
+ @validate_call
1680
+ def patch_metrics(
1681
+ self,
1682
+ metric_request_dto: MetricRequestDTO,
1683
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1684
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1685
+ _request_timeout: Union[
1686
+ None,
1687
+ Annotated[StrictFloat, Field(gt=0)],
1688
+ Tuple[
1689
+ Annotated[StrictFloat, Field(gt=0)],
1690
+ Annotated[StrictFloat, Field(gt=0)]
1691
+ ]
1692
+ ] = None,
1693
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1694
+ _content_type: Optional[StrictStr] = None,
1695
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1696
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1697
+ ) -> BulkChangeResponseDTO:
1698
+ """Partially update metrics
1699
+
1700
+ Make partial changes to existing simple or derived metrics. The response returns whether each metric was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the metric definition, use `PATCH` to change specific fields in the metric without affecting omitted fields. To replace a metric's entire definition, see the `PUT` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1701
+
1702
+ :param metric_request_dto: (required)
1703
+ :type metric_request_dto: MetricRequestDTO
1704
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1705
+ :type target_tenant_id: str
1706
+ :param project_id: Optionally, specify a project in which to make the request.
1707
+ :type project_id: str
1708
+ :param _request_timeout: timeout setting for this request. If one
1709
+ number provided, it will be total request
1710
+ timeout. It can also be a pair (tuple) of
1711
+ (connection, read) timeouts.
1712
+ :type _request_timeout: int, tuple(int, int), optional
1713
+ :param _request_auth: set to override the auth_settings for an a single
1714
+ request; this effectively ignores the
1715
+ authentication in the spec for a single request.
1716
+ :type _request_auth: dict, optional
1717
+ :param _content_type: force content-type for the request.
1718
+ :type _content_type: str, Optional
1719
+ :param _headers: set to override the headers for a single
1720
+ request; this effectively ignores the headers
1721
+ in the spec for a single request.
1722
+ :type _headers: dict, optional
1723
+ :param _host_index: set to override the host_index for a single
1724
+ request; this effectively ignores the host_index
1725
+ in the spec for a single request.
1726
+ :type _host_index: int, optional
1727
+ :return: Returns the result object.
1728
+ """ # noqa: E501
1729
+
1730
+ _param = self._patch_metrics_serialize(
1731
+ metric_request_dto=metric_request_dto,
1732
+ target_tenant_id=target_tenant_id,
1733
+ project_id=project_id,
1734
+ _request_auth=_request_auth,
1735
+ _content_type=_content_type,
1736
+ _headers=_headers,
1737
+ _host_index=_host_index
1738
+ )
1739
+
1740
+ _response_types_map: Dict[str, Optional[str]] = {
1741
+ '200': "BulkChangeResponseDTO",
1742
+ } response_data = self.api_client.call_api(
1743
+ *_param,
1744
+ _request_timeout=_request_timeout
1745
+ )
1746
+ response_data.read()
1747
+ return self.api_client.response_deserialize(
1748
+ response_data=response_data,
1749
+ response_types_map=_response_types_map,
1750
+ ).data
1751
+
1752
+
1753
+ @validate_call
1754
+ def patch_metrics_with_http_info(
1755
+ self,
1756
+ metric_request_dto: MetricRequestDTO,
1757
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1758
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1759
+ _request_timeout: Union[
1760
+ None,
1761
+ Annotated[StrictFloat, Field(gt=0)],
1762
+ Tuple[
1763
+ Annotated[StrictFloat, Field(gt=0)],
1764
+ Annotated[StrictFloat, Field(gt=0)]
1765
+ ]
1766
+ ] = None,
1767
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1768
+ _content_type: Optional[StrictStr] = None,
1769
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1770
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1771
+ ) -> ApiResponse[BulkChangeResponseDTO]:
1772
+ """Partially update metrics
1773
+
1774
+ Make partial changes to existing simple or derived metrics. The response returns whether each metric was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the metric definition, use `PATCH` to change specific fields in the metric without affecting omitted fields. To replace a metric's entire definition, see the `PUT` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1775
+
1776
+ :param metric_request_dto: (required)
1777
+ :type metric_request_dto: MetricRequestDTO
1778
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1779
+ :type target_tenant_id: str
1780
+ :param project_id: Optionally, specify a project in which to make the request.
1781
+ :type project_id: str
1782
+ :param _request_timeout: timeout setting for this request. If one
1783
+ number provided, it will be total request
1784
+ timeout. It can also be a pair (tuple) of
1785
+ (connection, read) timeouts.
1786
+ :type _request_timeout: int, tuple(int, int), optional
1787
+ :param _request_auth: set to override the auth_settings for an a single
1788
+ request; this effectively ignores the
1789
+ authentication in the spec for a single request.
1790
+ :type _request_auth: dict, optional
1791
+ :param _content_type: force content-type for the request.
1792
+ :type _content_type: str, Optional
1793
+ :param _headers: set to override the headers for a single
1794
+ request; this effectively ignores the headers
1795
+ in the spec for a single request.
1796
+ :type _headers: dict, optional
1797
+ :param _host_index: set to override the host_index for a single
1798
+ request; this effectively ignores the host_index
1799
+ in the spec for a single request.
1800
+ :type _host_index: int, optional
1801
+ :return: Returns the result object.
1802
+ """ # noqa: E501
1803
+
1804
+ _param = self._patch_metrics_serialize(
1805
+ metric_request_dto=metric_request_dto,
1806
+ target_tenant_id=target_tenant_id,
1807
+ project_id=project_id,
1808
+ _request_auth=_request_auth,
1809
+ _content_type=_content_type,
1810
+ _headers=_headers,
1811
+ _host_index=_host_index
1812
+ )
1813
+
1814
+ _response_types_map: Dict[str, Optional[str]] = {
1815
+ '200': "BulkChangeResponseDTO",
1816
+ } response_data = self.api_client.call_api(
1817
+ *_param,
1818
+ _request_timeout=_request_timeout
1819
+ )
1820
+ response_data.read()
1821
+ return self.api_client.response_deserialize(
1822
+ response_data=response_data,
1823
+ response_types_map=_response_types_map,
1824
+ )
1825
+
1826
+
1827
+ @validate_call
1828
+ def patch_metrics_without_preload_content(
1829
+ self,
1830
+ metric_request_dto: MetricRequestDTO,
1831
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1832
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1833
+ _request_timeout: Union[
1834
+ None,
1835
+ Annotated[StrictFloat, Field(gt=0)],
1836
+ Tuple[
1837
+ Annotated[StrictFloat, Field(gt=0)],
1838
+ Annotated[StrictFloat, Field(gt=0)]
1839
+ ]
1840
+ ] = None,
1841
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1842
+ _content_type: Optional[StrictStr] = None,
1843
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1844
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1845
+ ) -> RESTResponseType:
1846
+ """Partially update metrics
1847
+
1848
+ Make partial changes to existing simple or derived metrics. The response returns whether each metric was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the metric definition, use `PATCH` to change specific fields in the metric without affecting omitted fields. To replace a metric's entire definition, see the `PUT` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1849
+
1850
+ :param metric_request_dto: (required)
1851
+ :type metric_request_dto: MetricRequestDTO
1852
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
1853
+ :type target_tenant_id: str
1854
+ :param project_id: Optionally, specify a project in which to make the request.
1855
+ :type project_id: str
1856
+ :param _request_timeout: timeout setting for this request. If one
1857
+ number provided, it will be total request
1858
+ timeout. It can also be a pair (tuple) of
1859
+ (connection, read) timeouts.
1860
+ :type _request_timeout: int, tuple(int, int), optional
1861
+ :param _request_auth: set to override the auth_settings for an a single
1862
+ request; this effectively ignores the
1863
+ authentication in the spec for a single request.
1864
+ :type _request_auth: dict, optional
1865
+ :param _content_type: force content-type for the request.
1866
+ :type _content_type: str, Optional
1867
+ :param _headers: set to override the headers for a single
1868
+ request; this effectively ignores the headers
1869
+ in the spec for a single request.
1870
+ :type _headers: dict, optional
1871
+ :param _host_index: set to override the host_index for a single
1872
+ request; this effectively ignores the host_index
1873
+ in the spec for a single request.
1874
+ :type _host_index: int, optional
1875
+ :return: Returns the result object.
1876
+ """ # noqa: E501
1877
+
1878
+ _param = self._patch_metrics_serialize(
1879
+ metric_request_dto=metric_request_dto,
1880
+ target_tenant_id=target_tenant_id,
1881
+ project_id=project_id,
1882
+ _request_auth=_request_auth,
1883
+ _content_type=_content_type,
1884
+ _headers=_headers,
1885
+ _host_index=_host_index
1886
+ )
1887
+
1888
+ _response_types_map: Dict[str, Optional[str]] = {
1889
+ '200': "BulkChangeResponseDTO",
1890
+ } response_data = self.api_client.call_api(
1891
+ *_param,
1892
+ _request_timeout=_request_timeout
1893
+ )
1894
+ return response_data.response
1895
+
1896
+
1897
+ def _patch_metrics_serialize(
1898
+ self,
1899
+ metric_request_dto,
1900
+ target_tenant_id,
1901
+ project_id,
1902
+ _request_auth,
1903
+ _content_type,
1904
+ _headers,
1905
+ _host_index,
1906
+ ) -> RequestSerialized:
1907
+
1908
+ _host = None
1909
+
1910
+ _collection_formats: Dict[str, str] = {
1911
+ }
1912
+
1913
+ _path_params: Dict[str, str] = {}
1914
+ _query_params: List[Tuple[str, str]] = []
1915
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1916
+ _form_params: List[Tuple[str, str]] = []
1917
+ _files: Dict[
1918
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1919
+ ] = {}
1920
+ _body_params: Optional[bytes] = None
1921
+
1922
+ # process the path parameters
1923
+ # process the query parameters
1924
+ # process the header parameters
1925
+ if target_tenant_id is not None:
1926
+ _header_params['TargetTenantID'] = target_tenant_id
1927
+ if project_id is not None:
1928
+ _header_params['ProjectID'] = project_id
1929
+ # process the form parameters
1930
+ # process the body parameter
1931
+ if metric_request_dto is not None:
1932
+ _body_params = metric_request_dto
1933
+
1934
+
1935
+ # set the HTTP header `Accept`
1936
+ if 'Accept' not in _header_params:
1937
+ _header_params['Accept'] = self.api_client.select_header_accept(
1938
+ [
1939
+ 'application/json'
1940
+ ]
1941
+ )
1942
+
1943
+ # set the HTTP header `Content-Type`
1944
+ if _content_type:
1945
+ _header_params['Content-Type'] = _content_type
1946
+ else:
1947
+ _default_content_type = (
1948
+ self.api_client.select_header_content_type(
1949
+ [
1950
+ 'application/json'
1951
+ ]
1952
+ )
1953
+ )
1954
+ if _default_content_type is not None:
1955
+ _header_params['Content-Type'] = _default_content_type
1956
+
1957
+ # authentication setting
1958
+ _auth_settings: List[str] = [
1959
+ 'CookieAuth',
1960
+ 'ApiKeyAuth',
1961
+ 'OAuth2Auth',
1962
+ 'OAuth2Auth',
1963
+ 'BearerAuth'
1964
+ ]
1965
+
1966
+ return self.api_client.param_serialize(
1967
+ method='PATCH',
1968
+ resource_path='/v2alpha/data/model/metrics',
1969
+ path_params=_path_params,
1970
+ query_params=_query_params,
1971
+ header_params=_header_params,
1972
+ body=_body_params,
1973
+ post_params=_form_params,
1974
+ files=_files,
1975
+ auth_settings=_auth_settings,
1976
+ collection_formats=_collection_formats,
1977
+ _host=_host,
1978
+ _request_auth=_request_auth
1979
+ )
1980
+
1981
+
1982
+
1983
+
1984
+ @validate_call
1985
+ def put_metrics(
1986
+ self,
1987
+ metric_request_dto: MetricRequestDTO,
1988
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
1989
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
1990
+ _request_timeout: Union[
1991
+ None,
1992
+ Annotated[StrictFloat, Field(gt=0)],
1993
+ Tuple[
1994
+ Annotated[StrictFloat, Field(gt=0)],
1995
+ Annotated[StrictFloat, Field(gt=0)]
1996
+ ]
1997
+ ] = None,
1998
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1999
+ _content_type: Optional[StrictStr] = None,
2000
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2001
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2002
+ ) -> BulkChangeResponseDTO:
2003
+ """Update metrics
2004
+
2005
+ Update existing simple or derived metrics. The response returns whether each metric was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the metric. To partially update a metric, see the `PATCH` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2006
+
2007
+ :param metric_request_dto: (required)
2008
+ :type metric_request_dto: MetricRequestDTO
2009
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
2010
+ :type target_tenant_id: str
2011
+ :param project_id: Optionally, specify a project in which to make the request.
2012
+ :type project_id: str
2013
+ :param _request_timeout: timeout setting for this request. If one
2014
+ number provided, it will be total request
2015
+ timeout. It can also be a pair (tuple) of
2016
+ (connection, read) timeouts.
2017
+ :type _request_timeout: int, tuple(int, int), optional
2018
+ :param _request_auth: set to override the auth_settings for an a single
2019
+ request; this effectively ignores the
2020
+ authentication in the spec for a single request.
2021
+ :type _request_auth: dict, optional
2022
+ :param _content_type: force content-type for the request.
2023
+ :type _content_type: str, Optional
2024
+ :param _headers: set to override the headers for a single
2025
+ request; this effectively ignores the headers
2026
+ in the spec for a single request.
2027
+ :type _headers: dict, optional
2028
+ :param _host_index: set to override the host_index for a single
2029
+ request; this effectively ignores the host_index
2030
+ in the spec for a single request.
2031
+ :type _host_index: int, optional
2032
+ :return: Returns the result object.
2033
+ """ # noqa: E501
2034
+
2035
+ _param = self._put_metrics_serialize(
2036
+ metric_request_dto=metric_request_dto,
2037
+ target_tenant_id=target_tenant_id,
2038
+ project_id=project_id,
2039
+ _request_auth=_request_auth,
2040
+ _content_type=_content_type,
2041
+ _headers=_headers,
2042
+ _host_index=_host_index
2043
+ )
2044
+
2045
+ _response_types_map: Dict[str, Optional[str]] = {
2046
+ '200': "BulkChangeResponseDTO",
2047
+ } response_data = self.api_client.call_api(
2048
+ *_param,
2049
+ _request_timeout=_request_timeout
2050
+ )
2051
+ response_data.read()
2052
+ return self.api_client.response_deserialize(
2053
+ response_data=response_data,
2054
+ response_types_map=_response_types_map,
2055
+ ).data
2056
+
2057
+
2058
+ @validate_call
2059
+ def put_metrics_with_http_info(
2060
+ self,
2061
+ metric_request_dto: MetricRequestDTO,
2062
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
2063
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
2064
+ _request_timeout: Union[
2065
+ None,
2066
+ Annotated[StrictFloat, Field(gt=0)],
2067
+ Tuple[
2068
+ Annotated[StrictFloat, Field(gt=0)],
2069
+ Annotated[StrictFloat, Field(gt=0)]
2070
+ ]
2071
+ ] = None,
2072
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2073
+ _content_type: Optional[StrictStr] = None,
2074
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2075
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2076
+ ) -> ApiResponse[BulkChangeResponseDTO]:
2077
+ """Update metrics
2078
+
2079
+ Update existing simple or derived metrics. The response returns whether each metric was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the metric. To partially update a metric, see the `PATCH` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2080
+
2081
+ :param metric_request_dto: (required)
2082
+ :type metric_request_dto: MetricRequestDTO
2083
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
2084
+ :type target_tenant_id: str
2085
+ :param project_id: Optionally, specify a project in which to make the request.
2086
+ :type project_id: str
2087
+ :param _request_timeout: timeout setting for this request. If one
2088
+ number provided, it will be total request
2089
+ timeout. It can also be a pair (tuple) of
2090
+ (connection, read) timeouts.
2091
+ :type _request_timeout: int, tuple(int, int), optional
2092
+ :param _request_auth: set to override the auth_settings for an a single
2093
+ request; this effectively ignores the
2094
+ authentication in the spec for a single request.
2095
+ :type _request_auth: dict, optional
2096
+ :param _content_type: force content-type for the request.
2097
+ :type _content_type: str, Optional
2098
+ :param _headers: set to override the headers for a single
2099
+ request; this effectively ignores the headers
2100
+ in the spec for a single request.
2101
+ :type _headers: dict, optional
2102
+ :param _host_index: set to override the host_index for a single
2103
+ request; this effectively ignores the host_index
2104
+ in the spec for a single request.
2105
+ :type _host_index: int, optional
2106
+ :return: Returns the result object.
2107
+ """ # noqa: E501
2108
+
2109
+ _param = self._put_metrics_serialize(
2110
+ metric_request_dto=metric_request_dto,
2111
+ target_tenant_id=target_tenant_id,
2112
+ project_id=project_id,
2113
+ _request_auth=_request_auth,
2114
+ _content_type=_content_type,
2115
+ _headers=_headers,
2116
+ _host_index=_host_index
2117
+ )
2118
+
2119
+ _response_types_map: Dict[str, Optional[str]] = {
2120
+ '200': "BulkChangeResponseDTO",
2121
+ } response_data = self.api_client.call_api(
2122
+ *_param,
2123
+ _request_timeout=_request_timeout
2124
+ )
2125
+ response_data.read()
2126
+ return self.api_client.response_deserialize(
2127
+ response_data=response_data,
2128
+ response_types_map=_response_types_map,
2129
+ )
2130
+
2131
+
2132
+ @validate_call
2133
+ def put_metrics_without_preload_content(
2134
+ self,
2135
+ metric_request_dto: MetricRequestDTO,
2136
+ target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
2137
+ project_id: Annotated[Optional[UUID], Field(description="Optionally, specify a project in which to make the request.")] = None,
2138
+ _request_timeout: Union[
2139
+ None,
2140
+ Annotated[StrictFloat, Field(gt=0)],
2141
+ Tuple[
2142
+ Annotated[StrictFloat, Field(gt=0)],
2143
+ Annotated[StrictFloat, Field(gt=0)]
2144
+ ]
2145
+ ] = None,
2146
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2147
+ _content_type: Optional[StrictStr] = None,
2148
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2149
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2150
+ ) -> RESTResponseType:
2151
+ """Update metrics
2152
+
2153
+ Update existing simple or derived metrics. The response returns whether each metric was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the metric. To partially update a metric, see the `PATCH` method. <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2154
+
2155
+ :param metric_request_dto: (required)
2156
+ :type metric_request_dto: MetricRequestDTO
2157
+ :param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
2158
+ :type target_tenant_id: str
2159
+ :param project_id: Optionally, specify a project in which to make the request.
2160
+ :type project_id: str
2161
+ :param _request_timeout: timeout setting for this request. If one
2162
+ number provided, it will be total request
2163
+ timeout. It can also be a pair (tuple) of
2164
+ (connection, read) timeouts.
2165
+ :type _request_timeout: int, tuple(int, int), optional
2166
+ :param _request_auth: set to override the auth_settings for an a single
2167
+ request; this effectively ignores the
2168
+ authentication in the spec for a single request.
2169
+ :type _request_auth: dict, optional
2170
+ :param _content_type: force content-type for the request.
2171
+ :type _content_type: str, Optional
2172
+ :param _headers: set to override the headers for a single
2173
+ request; this effectively ignores the headers
2174
+ in the spec for a single request.
2175
+ :type _headers: dict, optional
2176
+ :param _host_index: set to override the host_index for a single
2177
+ request; this effectively ignores the host_index
2178
+ in the spec for a single request.
2179
+ :type _host_index: int, optional
2180
+ :return: Returns the result object.
2181
+ """ # noqa: E501
2182
+
2183
+ _param = self._put_metrics_serialize(
2184
+ metric_request_dto=metric_request_dto,
2185
+ target_tenant_id=target_tenant_id,
2186
+ project_id=project_id,
2187
+ _request_auth=_request_auth,
2188
+ _content_type=_content_type,
2189
+ _headers=_headers,
2190
+ _host_index=_host_index
2191
+ )
2192
+
2193
+ _response_types_map: Dict[str, Optional[str]] = {
2194
+ '200': "BulkChangeResponseDTO",
2195
+ } response_data = self.api_client.call_api(
2196
+ *_param,
2197
+ _request_timeout=_request_timeout
2198
+ )
2199
+ return response_data.response
2200
+
2201
+
2202
+ def _put_metrics_serialize(
2203
+ self,
2204
+ metric_request_dto,
2205
+ target_tenant_id,
2206
+ project_id,
2207
+ _request_auth,
2208
+ _content_type,
2209
+ _headers,
2210
+ _host_index,
2211
+ ) -> RequestSerialized:
2212
+
2213
+ _host = None
2214
+
2215
+ _collection_formats: Dict[str, str] = {
2216
+ }
2217
+
2218
+ _path_params: Dict[str, str] = {}
2219
+ _query_params: List[Tuple[str, str]] = []
2220
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2221
+ _form_params: List[Tuple[str, str]] = []
2222
+ _files: Dict[
2223
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2224
+ ] = {}
2225
+ _body_params: Optional[bytes] = None
2226
+
2227
+ # process the path parameters
2228
+ # process the query parameters
2229
+ # process the header parameters
2230
+ if target_tenant_id is not None:
2231
+ _header_params['TargetTenantID'] = target_tenant_id
2232
+ if project_id is not None:
2233
+ _header_params['ProjectID'] = project_id
2234
+ # process the form parameters
2235
+ # process the body parameter
2236
+ if metric_request_dto is not None:
2237
+ _body_params = metric_request_dto
2238
+
2239
+
2240
+ # set the HTTP header `Accept`
2241
+ if 'Accept' not in _header_params:
2242
+ _header_params['Accept'] = self.api_client.select_header_accept(
2243
+ [
2244
+ 'application/json'
2245
+ ]
2246
+ )
2247
+
2248
+ # set the HTTP header `Content-Type`
2249
+ if _content_type:
2250
+ _header_params['Content-Type'] = _content_type
2251
+ else:
2252
+ _default_content_type = (
2253
+ self.api_client.select_header_content_type(
2254
+ [
2255
+ 'application/json'
2256
+ ]
2257
+ )
2258
+ )
2259
+ if _default_content_type is not None:
2260
+ _header_params['Content-Type'] = _default_content_type
2261
+
2262
+ # authentication setting
2263
+ _auth_settings: List[str] = [
2264
+ 'CookieAuth',
2265
+ 'ApiKeyAuth',
2266
+ 'OAuth2Auth',
2267
+ 'OAuth2Auth',
2268
+ 'BearerAuth'
2269
+ ]
2270
+
2271
+ return self.api_client.param_serialize(
2272
+ method='PUT',
2273
+ resource_path='/v2alpha/data/model/metrics',
2274
+ path_params=_path_params,
2275
+ query_params=_query_params,
2276
+ header_params=_header_params,
2277
+ body=_body_params,
2278
+ post_params=_form_params,
2279
+ files=_files,
2280
+ auth_settings=_auth_settings,
2281
+ collection_formats=_collection_formats,
2282
+ _host=_host,
2283
+ _request_auth=_request_auth
2284
+ )
2285
+
2286
+