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