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