visier-platform-sdk 22222222.99201.1892b3__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 (664) hide show
  1. visier_platform_sdk/__init__.py +684 -0
  2. visier_platform_sdk/api/__init__.py +42 -0
  3. visier_platform_sdk/api/basic_authentication_api.py +625 -0
  4. visier_platform_sdk/api/benchmarks_api.py +936 -0
  5. visier_platform_sdk/api/concepts_v2_api.py +2307 -0
  6. visier_platform_sdk/api/consolidated_analytics_api.py +3265 -0
  7. visier_platform_sdk/api/data_and_job_handling_api.py +8346 -0
  8. visier_platform_sdk/api/data_intake_api.py +1866 -0
  9. visier_platform_sdk/api/data_model_api.py +13164 -0
  10. visier_platform_sdk/api/data_query_api.py +1226 -0
  11. visier_platform_sdk/api/data_upload_api.py +343 -0
  12. visier_platform_sdk/api/data_version_export_api.py +1724 -0
  13. visier_platform_sdk/api/dimensions_api.py +3050 -0
  14. visier_platform_sdk/api/direct_data_intake_api.py +3039 -0
  15. visier_platform_sdk/api/email_domains_api.py +880 -0
  16. visier_platform_sdk/api/encryption_keys_api.py +835 -0
  17. visier_platform_sdk/api/jobs_library_api.py +1168 -0
  18. visier_platform_sdk/api/network_subnets_api.py +1170 -0
  19. visier_platform_sdk/api/o_auth2_api.py +1021 -0
  20. visier_platform_sdk/api/object_configuration_api.py +1752 -0
  21. visier_platform_sdk/api/permissions_api.py +4295 -0
  22. visier_platform_sdk/api/pgp_key_api.py +1161 -0
  23. visier_platform_sdk/api/planning_data_load_api.py +740 -0
  24. visier_platform_sdk/api/production_versions_api.py +944 -0
  25. visier_platform_sdk/api/profiles_api.py +2873 -0
  26. visier_platform_sdk/api/projects_api.py +2128 -0
  27. visier_platform_sdk/api/release_version_configuration_api.py +835 -0
  28. visier_platform_sdk/api/reporting_api.py +1757 -0
  29. visier_platform_sdk/api/search_api.py +356 -0
  30. visier_platform_sdk/api/skills_library_api.py +2632 -0
  31. visier_platform_sdk/api/source_files_download_api.py +335 -0
  32. visier_platform_sdk/api/sources_api.py +652 -0
  33. visier_platform_sdk/api/system_status_api.py +570 -0
  34. visier_platform_sdk/api/tenants_v1_api.py +2836 -0
  35. visier_platform_sdk/api/tenants_v2_api.py +1595 -0
  36. visier_platform_sdk/api/user_groups_v2_api.py +2332 -0
  37. visier_platform_sdk/api/users_v1_api.py +6157 -0
  38. visier_platform_sdk/api/users_v2_api.py +973 -0
  39. visier_platform_sdk/api/vee_api.py +1161 -0
  40. visier_platform_sdk/api/webhooks_api.py +2281 -0
  41. visier_platform_sdk/api_client.py +811 -0
  42. visier_platform_sdk/api_response.py +21 -0
  43. visier_platform_sdk/configuration.py +808 -0
  44. visier_platform_sdk/exceptions.py +217 -0
  45. visier_platform_sdk/models/__init__.py +630 -0
  46. visier_platform_sdk/models/admin_all_tenants_status_apidto.py +100 -0
  47. visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py +112 -0
  48. visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py +96 -0
  49. visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py +98 -0
  50. visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py +92 -0
  51. visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py +96 -0
  52. visier_platform_sdk/models/admin_business_location_dto.py +90 -0
  53. visier_platform_sdk/models/admin_connector_info_response_dto.py +92 -0
  54. visier_platform_sdk/models/admin_connector_setting_request_dto.py +90 -0
  55. visier_platform_sdk/models/admin_connector_setting_response_dto.py +92 -0
  56. visier_platform_sdk/models/admin_connector_settings_response_dto.py +102 -0
  57. visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py +88 -0
  58. visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py +88 -0
  59. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py +88 -0
  60. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py +88 -0
  61. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py +92 -0
  62. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py +96 -0
  63. visier_platform_sdk/models/admin_custom_property_dto.py +90 -0
  64. visier_platform_sdk/models/admin_custom_tenant_property_dto.py +90 -0
  65. visier_platform_sdk/models/admin_data_import_definition_apidto.py +92 -0
  66. visier_platform_sdk/models/admin_data_import_definitions_apidto.py +100 -0
  67. visier_platform_sdk/models/admin_data_version_and_date_dto.py +90 -0
  68. visier_platform_sdk/models/admin_delete_user_group_v2_request.py +88 -0
  69. visier_platform_sdk/models/admin_element_ids_dto.py +88 -0
  70. visier_platform_sdk/models/admin_email_domains_dto.py +90 -0
  71. visier_platform_sdk/models/admin_excluded_sources_body.py +88 -0
  72. visier_platform_sdk/models/admin_extractor_setting_apidto.py +100 -0
  73. visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py +90 -0
  74. visier_platform_sdk/models/admin_extractor_settings_apidto.py +96 -0
  75. visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py +90 -0
  76. visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py +88 -0
  77. visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py +150 -0
  78. visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py +96 -0
  79. visier_platform_sdk/models/admin_key_name.py +88 -0
  80. visier_platform_sdk/models/admin_mask_message.py +88 -0
  81. visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py +98 -0
  82. visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py +100 -0
  83. visier_platform_sdk/models/admin_network_subnets_message_request.py +90 -0
  84. visier_platform_sdk/models/admin_network_subnets_message_response.py +88 -0
  85. visier_platform_sdk/models/admin_permission_response_dto.py +90 -0
  86. visier_platform_sdk/models/admin_permissions_list_dto.py +96 -0
  87. visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py +102 -0
  88. visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py +90 -0
  89. visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py +96 -0
  90. visier_platform_sdk/models/admin_product_release_dto.py +94 -0
  91. visier_platform_sdk/models/admin_product_releases_dto.py +96 -0
  92. visier_platform_sdk/models/admin_product_version_dto.py +92 -0
  93. visier_platform_sdk/models/admin_product_versions_dto.py +96 -0
  94. visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py +94 -0
  95. visier_platform_sdk/models/admin_product_versions_update_response_dto.py +106 -0
  96. visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py +92 -0
  97. visier_platform_sdk/models/admin_put_project_commits_request.py +88 -0
  98. visier_platform_sdk/models/admin_security_assignment_response_dto.py +96 -0
  99. visier_platform_sdk/models/admin_set_connector_setting_request_dto.py +98 -0
  100. visier_platform_sdk/models/admin_set_connector_setting_response_dto.py +112 -0
  101. visier_platform_sdk/models/admin_set_connector_settings_request_dto.py +96 -0
  102. visier_platform_sdk/models/admin_set_connector_settings_response_dto.py +96 -0
  103. visier_platform_sdk/models/admin_simple_user_dto.py +90 -0
  104. visier_platform_sdk/models/admin_target_project_for_tenant_dto.py +90 -0
  105. visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py +96 -0
  106. visier_platform_sdk/models/admin_tenant_assignments_dto.py +114 -0
  107. visier_platform_sdk/models/admin_tenant_code_body.py +88 -0
  108. visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py +98 -0
  109. visier_platform_sdk/models/admin_tenant_detail_apidto.py +130 -0
  110. visier_platform_sdk/models/admin_tenant_details_traits_dto.py +112 -0
  111. visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py +156 -0
  112. visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py +100 -0
  113. visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py +156 -0
  114. visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py +136 -0
  115. visier_platform_sdk/models/admin_tenant_provision_apidto.py +110 -0
  116. visier_platform_sdk/models/admin_tenant_status_apidto.py +94 -0
  117. visier_platform_sdk/models/admin_update_tenant_model.py +98 -0
  118. visier_platform_sdk/models/admin_user_group_change_definition_dto.py +108 -0
  119. visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py +104 -0
  120. visier_platform_sdk/models/admin_user_group_change_failure_dto.py +96 -0
  121. visier_platform_sdk/models/admin_user_group_change_filter_dto.py +100 -0
  122. visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py +90 -0
  123. visier_platform_sdk/models/admin_user_group_change_response_dto.py +106 -0
  124. visier_platform_sdk/models/admin_user_group_change_success_dto.py +94 -0
  125. visier_platform_sdk/models/admin_user_group_change_users_dto.py +105 -0
  126. visier_platform_sdk/models/admin_user_group_delete_dto.py +92 -0
  127. visier_platform_sdk/models/admin_user_group_delete_failure_dto.py +96 -0
  128. visier_platform_sdk/models/admin_user_group_delete_response_dto.py +106 -0
  129. visier_platform_sdk/models/admin_user_group_delete_success_dto.py +92 -0
  130. visier_platform_sdk/models/admin_user_group_filters_dto.py +96 -0
  131. visier_platform_sdk/models/admin_user_group_get_api_response_dto.py +100 -0
  132. visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py +98 -0
  133. visier_platform_sdk/models/admin_user_groups_change_dto.py +96 -0
  134. visier_platform_sdk/models/admin_user_groups_delete_request_dto.py +96 -0
  135. visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py +100 -0
  136. visier_platform_sdk/models/admin_user_groups_users_dto.py +100 -0
  137. visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py +98 -0
  138. visier_platform_sdk/models/admin_user_security_assignments_dto.py +100 -0
  139. visier_platform_sdk/models/admin_users_to_user_group_request_dto.py +90 -0
  140. visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py +102 -0
  141. visier_platform_sdk/models/analysis_common_report_create_request_dto.py +90 -0
  142. visier_platform_sdk/models/analysis_common_report_delete_success_dto.py +88 -0
  143. visier_platform_sdk/models/analysis_common_report_dto.py +115 -0
  144. visier_platform_sdk/models/analysis_common_report_list_response_dto.py +96 -0
  145. visier_platform_sdk/models/analysis_common_vee_clarification_dto.py +98 -0
  146. visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py +88 -0
  147. visier_platform_sdk/models/analysis_common_vee_corrections_dto.py +109 -0
  148. visier_platform_sdk/models/analysis_common_vee_data_dto.py +90 -0
  149. visier_platform_sdk/models/analysis_common_vee_feedback_dto.py +96 -0
  150. visier_platform_sdk/models/analysis_common_vee_options_dto.py +110 -0
  151. visier_platform_sdk/models/analysis_common_vee_question_dto.py +102 -0
  152. visier_platform_sdk/models/analysis_common_vee_response_dto.py +132 -0
  153. visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py +107 -0
  154. visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py +90 -0
  155. visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py +94 -0
  156. visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py +96 -0
  157. visier_platform_sdk/models/analysis_common_vee_status_code_dto.py +100 -0
  158. visier_platform_sdk/models/analysis_common_vee_visual_dto.py +92 -0
  159. visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py +90 -0
  160. visier_platform_sdk/models/api_error.py +92 -0
  161. visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py +117 -0
  162. visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py +100 -0
  163. visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py +96 -0
  164. visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py +96 -0
  165. visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py +88 -0
  166. visier_platform_sdk/models/benchmark_info.py +92 -0
  167. visier_platform_sdk/models/benchmark_value.py +108 -0
  168. visier_platform_sdk/models/data_in_assign_connector_credential_request.py +96 -0
  169. visier_platform_sdk/models/data_in_connector.py +98 -0
  170. visier_platform_sdk/models/data_in_data_load_request.py +92 -0
  171. visier_platform_sdk/models/data_in_data_load_request_model.py +90 -0
  172. visier_platform_sdk/models/data_in_data_load_response.py +88 -0
  173. visier_platform_sdk/models/data_in_data_transfer_result_detail.py +94 -0
  174. visier_platform_sdk/models/data_in_data_version_object.py +90 -0
  175. visier_platform_sdk/models/data_in_disable_dv_model.py +96 -0
  176. visier_platform_sdk/models/data_in_disable_dv_request.py +92 -0
  177. visier_platform_sdk/models/data_in_disable_dv_response.py +100 -0
  178. visier_platform_sdk/models/data_in_dispatching_job_status_response.py +94 -0
  179. visier_platform_sdk/models/data_in_exclude_data_uploads_request.py +96 -0
  180. visier_platform_sdk/models/data_in_extraction_job.py +94 -0
  181. visier_platform_sdk/models/data_in_extraction_job_and_status_response.py +104 -0
  182. visier_platform_sdk/models/data_in_include_data_uploads_request.py +96 -0
  183. visier_platform_sdk/models/data_in_job_status_list_response.py +100 -0
  184. visier_platform_sdk/models/data_in_job_status_with_start_time.py +96 -0
  185. visier_platform_sdk/models/data_in_processing_job.py +96 -0
  186. visier_platform_sdk/models/data_in_processing_job_and_status_response.py +104 -0
  187. visier_platform_sdk/models/data_in_processing_job_status_response.py +104 -0
  188. visier_platform_sdk/models/data_in_push_data_cancel_response.py +102 -0
  189. visier_platform_sdk/models/data_in_push_data_complete_request.py +90 -0
  190. visier_platform_sdk/models/data_in_push_data_complete_response.py +104 -0
  191. visier_platform_sdk/models/data_in_push_data_response.py +104 -0
  192. visier_platform_sdk/models/data_in_receiving_job.py +92 -0
  193. visier_platform_sdk/models/data_in_receiving_job_and_status_response.py +104 -0
  194. visier_platform_sdk/models/data_in_receiving_job_status_response.py +104 -0
  195. visier_platform_sdk/models/data_in_result.py +96 -0
  196. visier_platform_sdk/models/data_in_source.py +98 -0
  197. visier_platform_sdk/models/data_in_start_extraction_response.py +88 -0
  198. visier_platform_sdk/models/data_in_start_transfer_response.py +88 -0
  199. visier_platform_sdk/models/data_in_tenant.py +100 -0
  200. visier_platform_sdk/models/data_in_tenant_and_credential.py +90 -0
  201. visier_platform_sdk/models/data_in_upload_to_exclude.py +98 -0
  202. visier_platform_sdk/models/data_in_upload_to_include.py +98 -0
  203. visier_platform_sdk/models/data_out_list_response.py +101 -0
  204. visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py +90 -0
  205. visier_platform_sdk/models/dataservices_common_member_values_dto.py +105 -0
  206. visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py +96 -0
  207. visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py +102 -0
  208. visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py +130 -0
  209. visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py +96 -0
  210. visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py +96 -0
  211. visier_platform_sdk/models/dataservices_datamodel_currency_dto.py +94 -0
  212. visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py +96 -0
  213. visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py +96 -0
  214. visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py +120 -0
  215. visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py +102 -0
  216. visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py +90 -0
  217. visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py +90 -0
  218. visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py +96 -0
  219. visier_platform_sdk/models/dataservices_datamodel_level_dto.py +92 -0
  220. visier_platform_sdk/models/dataservices_datamodel_member_dto.py +106 -0
  221. visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py +102 -0
  222. visier_platform_sdk/models/dataservices_datamodel_members_dto.py +96 -0
  223. visier_platform_sdk/models/dataservices_datamodel_metric_dto.py +122 -0
  224. visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py +96 -0
  225. visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py +98 -0
  226. visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py +110 -0
  227. visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py +110 -0
  228. visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py +94 -0
  229. visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py +88 -0
  230. visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py +92 -0
  231. visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py +92 -0
  232. visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py +96 -0
  233. visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py +98 -0
  234. visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py +123 -0
  235. visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py +96 -0
  236. visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py +115 -0
  237. visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py +124 -0
  238. visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py +96 -0
  239. visier_platform_sdk/models/dataservices_datamodel_properties_dto.py +96 -0
  240. visier_platform_sdk/models/dataservices_datamodel_property_dto.py +118 -0
  241. visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py +90 -0
  242. visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py +90 -0
  243. visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py +106 -0
  244. visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py +90 -0
  245. visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py +96 -0
  246. visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py +90 -0
  247. visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py +90 -0
  248. visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py +128 -0
  249. visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py +98 -0
  250. visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py +96 -0
  251. visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py +94 -0
  252. visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py +96 -0
  253. visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py +90 -0
  254. visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py +90 -0
  255. visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py +88 -0
  256. visier_platform_sdk/models/dataservices_query_cell_dto.py +102 -0
  257. visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py +102 -0
  258. visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py +92 -0
  259. visier_platform_sdk/models/dataservices_query_cell_set_dto.py +114 -0
  260. visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py +98 -0
  261. visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py +100 -0
  262. visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py +100 -0
  263. visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py +96 -0
  264. visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py +100 -0
  265. visier_platform_sdk/models/dataservices_query_lineage_dto.py +100 -0
  266. visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py +144 -0
  267. visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py +158 -0
  268. visier_platform_sdk/models/dataservices_query_list_query_source_dto.py +94 -0
  269. visier_platform_sdk/models/dataservices_query_member_filter_dto.py +98 -0
  270. visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py +98 -0
  271. visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py +90 -0
  272. visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py +94 -0
  273. visier_platform_sdk/models/dataservices_query_property_column_dto.py +94 -0
  274. visier_platform_sdk/models/dataservices_query_query_axis_dto.py +141 -0
  275. visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py +100 -0
  276. visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py +92 -0
  277. visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py +92 -0
  278. visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py +108 -0
  279. visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py +96 -0
  280. visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py +102 -0
  281. visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py +94 -0
  282. visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py +100 -0
  283. visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py +100 -0
  284. visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py +192 -0
  285. visier_platform_sdk/models/dataservices_query_query_filter_dto.py +106 -0
  286. visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py +94 -0
  287. visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py +104 -0
  288. visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py +100 -0
  289. visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py +110 -0
  290. visier_platform_sdk/models/dataservices_query_query_property_dto.py +120 -0
  291. visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py +134 -0
  292. visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py +150 -0
  293. visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py +144 -0
  294. visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py +134 -0
  295. visier_platform_sdk/models/dataservices_query_sort_option_dto.py +100 -0
  296. visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py +94 -0
  297. visier_platform_sdk/models/dataservices_query_time_shift_dto.py +112 -0
  298. visier_platform_sdk/models/description_entry.py +90 -0
  299. visier_platform_sdk/models/designer_adp_auth_params_dto.py +88 -0
  300. visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py +100 -0
  301. visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py +96 -0
  302. visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py +96 -0
  303. visier_platform_sdk/models/designer_api_calculation_concept_dto.py +96 -0
  304. visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py +96 -0
  305. visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py +92 -0
  306. visier_platform_sdk/models/designer_api_dimension_filter_dto.py +100 -0
  307. visier_platform_sdk/models/designer_api_dimension_member_dto.py +88 -0
  308. visier_platform_sdk/models/designer_api_perspective_configuration_dto.py +100 -0
  309. visier_platform_sdk/models/designer_api_perspective_node_dto.py +100 -0
  310. visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py +96 -0
  311. visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py +96 -0
  312. visier_platform_sdk/models/designer_api_selection_concept_dto.py +96 -0
  313. visier_platform_sdk/models/designer_api_selection_concept_list_dto.py +96 -0
  314. visier_platform_sdk/models/designer_bamboo_auth_params_dto.py +90 -0
  315. visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py +96 -0
  316. visier_platform_sdk/models/designer_big_query_auth_params_dto.py +104 -0
  317. visier_platform_sdk/models/designer_big_query_service_account_params_dto.py +90 -0
  318. visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py +88 -0
  319. visier_platform_sdk/models/designer_credential_creation_api_response_dto.py +102 -0
  320. visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py +92 -0
  321. visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py +88 -0
  322. visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py +88 -0
  323. visier_platform_sdk/models/designer_crypto_public_key_dto.py +96 -0
  324. visier_platform_sdk/models/designer_crypto_public_keys_dto.py +96 -0
  325. visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py +96 -0
  326. visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py +94 -0
  327. visier_platform_sdk/models/designer_data_provider_auth_information_dto.py +104 -0
  328. visier_platform_sdk/models/designer_data_provider_auth_params_dto.py +344 -0
  329. visier_platform_sdk/models/designer_data_provider_basic_information_dto.py +90 -0
  330. visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py +88 -0
  331. visier_platform_sdk/models/designer_data_version_export_column_dto.py +94 -0
  332. visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py +92 -0
  333. visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py +96 -0
  334. visier_platform_sdk/models/designer_data_version_export_dto.py +108 -0
  335. visier_platform_sdk/models/designer_data_version_export_file_dto.py +106 -0
  336. visier_platform_sdk/models/designer_data_version_export_job_status_dto.py +94 -0
  337. visier_platform_sdk/models/designer_data_version_export_part_file_dto.py +90 -0
  338. visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py +90 -0
  339. visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py +88 -0
  340. visier_platform_sdk/models/designer_data_version_export_table_dto.py +101 -0
  341. visier_platform_sdk/models/designer_data_version_exports_dto.py +96 -0
  342. visier_platform_sdk/models/designer_databricks_auth_params_dto.py +94 -0
  343. visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py +96 -0
  344. visier_platform_sdk/models/designer_dimensions_auth_params_dto.py +98 -0
  345. visier_platform_sdk/models/designer_download_source_files_dto.py +102 -0
  346. visier_platform_sdk/models/designer_download_source_files_response_dto.py +90 -0
  347. visier_platform_sdk/models/designer_extractor_credential_apidto.py +96 -0
  348. visier_platform_sdk/models/designer_extractor_credentials_apidto.py +100 -0
  349. visier_platform_sdk/models/designer_fusion_auth_params_dto.py +92 -0
  350. visier_platform_sdk/models/designer_gong_auth_params_dto.py +90 -0
  351. visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py +94 -0
  352. visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py +96 -0
  353. visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py +88 -0
  354. visier_platform_sdk/models/designer_icims_auth_params_dto.py +108 -0
  355. visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py +90 -0
  356. visier_platform_sdk/models/designer_jdbc_auth_params_dto.py +92 -0
  357. visier_platform_sdk/models/designer_jira_auth_params_dto.py +96 -0
  358. visier_platform_sdk/models/designer_jira_connect_params_dto.py +92 -0
  359. visier_platform_sdk/models/designer_lever_auth_params_dto.py +88 -0
  360. visier_platform_sdk/models/designer_medallia_auth_params_dto.py +94 -0
  361. visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py +94 -0
  362. visier_platform_sdk/models/designer_module_settings_dto.py +92 -0
  363. visier_platform_sdk/models/designer_my_sql_auth_params_dto.py +98 -0
  364. visier_platform_sdk/models/designer_namely_auth_params_dto.py +88 -0
  365. visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py +96 -0
  366. visier_platform_sdk/models/designer_push_data_column_definition_dto.py +98 -0
  367. visier_platform_sdk/models/designer_push_data_source_definition_dto.py +102 -0
  368. visier_platform_sdk/models/designer_push_data_source_definitions_dto.py +96 -0
  369. visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py +90 -0
  370. visier_platform_sdk/models/designer_redshift_auth_params_dto.py +100 -0
  371. visier_platform_sdk/models/designer_salesforce_auth_params_dto.py +90 -0
  372. visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py +94 -0
  373. visier_platform_sdk/models/designer_service_now_auth_params_dto.py +92 -0
  374. visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py +96 -0
  375. visier_platform_sdk/models/designer_slack_auth_params_dto.py +92 -0
  376. visier_platform_sdk/models/designer_snowflake_auth_params_dto.py +100 -0
  377. visier_platform_sdk/models/designer_sql_server_auth_params_dto.py +96 -0
  378. visier_platform_sdk/models/designer_subject_missing_access_dto.py +102 -0
  379. visier_platform_sdk/models/designer_success_factors_auth_params_dto.py +100 -0
  380. visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py +92 -0
  381. visier_platform_sdk/models/designer_tenant_module_dto.py +96 -0
  382. visier_platform_sdk/models/designer_ultimate_auth_params_dto.py +96 -0
  383. visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py +90 -0
  384. visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py +94 -0
  385. visier_platform_sdk/models/designer_webhook_webhook_details_dto.py +104 -0
  386. visier_platform_sdk/models/designer_webhook_webhook_dto.py +96 -0
  387. visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py +88 -0
  388. visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py +94 -0
  389. visier_platform_sdk/models/designer_webhook_webhook_request_dto.py +98 -0
  390. visier_platform_sdk/models/designer_webhook_webhooks_dto.py +96 -0
  391. visier_platform_sdk/models/designer_willow_auth_params_dto.py +90 -0
  392. visier_platform_sdk/models/designer_workday_auth_params_dto.py +110 -0
  393. visier_platform_sdk/models/designer_workday_o_auth_params_dto.py +92 -0
  394. visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py +96 -0
  395. visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py +92 -0
  396. visier_platform_sdk/models/designer_zoom_auth_params_dto.py +92 -0
  397. visier_platform_sdk/models/dimension_member.py +139 -0
  398. visier_platform_sdk/models/direct_data_upload_file_response_dto.py +92 -0
  399. visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py +92 -0
  400. visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py +102 -0
  401. visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py +100 -0
  402. visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py +88 -0
  403. visier_platform_sdk/models/dp_job_cancellation_result_dto.py +110 -0
  404. visier_platform_sdk/models/dp_job_cancellation_results_dto.py +96 -0
  405. visier_platform_sdk/models/dv_export_status.py +96 -0
  406. visier_platform_sdk/models/extracted_skill.py +94 -0
  407. visier_platform_sdk/models/generate_impersonation_token_request.py +88 -0
  408. visier_platform_sdk/models/google_protobuf_any.py +101 -0
  409. visier_platform_sdk/models/hierarchy.py +92 -0
  410. visier_platform_sdk/models/job.py +121 -0
  411. visier_platform_sdk/models/job_entry.py +92 -0
  412. visier_platform_sdk/models/job_feedback_input.py +92 -0
  413. visier_platform_sdk/models/job_search_failure_output.py +94 -0
  414. visier_platform_sdk/models/job_search_input.py +88 -0
  415. visier_platform_sdk/models/job_search_output.py +106 -0
  416. visier_platform_sdk/models/job_standardization_input.py +98 -0
  417. visier_platform_sdk/models/job_standardization_input_skills.py +90 -0
  418. visier_platform_sdk/models/location_search_failure_output.py +96 -0
  419. visier_platform_sdk/models/location_search_input.py +98 -0
  420. visier_platform_sdk/models/location_search_input1.py +92 -0
  421. visier_platform_sdk/models/location_search_output.py +106 -0
  422. visier_platform_sdk/models/location_search_successful_output.py +98 -0
  423. visier_platform_sdk/models/output_entry.py +98 -0
  424. visier_platform_sdk/models/output_entry1.py +98 -0
  425. visier_platform_sdk/models/output_entry1_matches_inner.py +94 -0
  426. visier_platform_sdk/models/plan_data_load_change_dto.py +94 -0
  427. visier_platform_sdk/models/plan_data_load_change_list_dto.py +98 -0
  428. visier_platform_sdk/models/plan_data_upload_response_dto.py +110 -0
  429. visier_platform_sdk/models/plan_row_data_load_response_dto.py +114 -0
  430. visier_platform_sdk/models/planning_get_plan_list_response_dto.py +98 -0
  431. visier_platform_sdk/models/planning_plan_data_load_error_dto.py +92 -0
  432. visier_platform_sdk/models/planning_plan_info_dto.py +106 -0
  433. visier_platform_sdk/models/planning_plan_item_dto.py +102 -0
  434. visier_platform_sdk/models/planning_plan_schema_dto.py +126 -0
  435. visier_platform_sdk/models/planning_plan_segment_level_dto.py +96 -0
  436. visier_platform_sdk/models/planning_plan_segment_level_member_dto.py +94 -0
  437. visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py +100 -0
  438. visier_platform_sdk/models/planning_plan_time_period_dto.py +90 -0
  439. visier_platform_sdk/models/planning_plan_with_schema_dto.py +108 -0
  440. visier_platform_sdk/models/planning_scenario_info_dto.py +92 -0
  441. visier_platform_sdk/models/salary_benchmark_input.py +100 -0
  442. visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +96 -0
  443. visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +106 -0
  444. visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +110 -0
  445. visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py +102 -0
  446. visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py +128 -0
  447. visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py +98 -0
  448. visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py +125 -0
  449. visier_platform_sdk/models/servicing_additional_capabilities_dto.py +88 -0
  450. visier_platform_sdk/models/servicing_admin_capability_config_dto.py +90 -0
  451. visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py +96 -0
  452. visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py +96 -0
  453. visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py +96 -0
  454. visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py +96 -0
  455. visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py +100 -0
  456. visier_platform_sdk/models/servicing_analytic_object_dto.py +132 -0
  457. visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py +102 -0
  458. visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py +114 -0
  459. visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py +92 -0
  460. visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py +90 -0
  461. visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py +102 -0
  462. visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py +96 -0
  463. visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py +106 -0
  464. visier_platform_sdk/models/servicing_capabilities_dto.py +92 -0
  465. visier_platform_sdk/models/servicing_capability_dto.py +92 -0
  466. visier_platform_sdk/models/servicing_capability_group_dto.py +146 -0
  467. visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py +92 -0
  468. visier_platform_sdk/models/servicing_commit_dto.py +92 -0
  469. visier_platform_sdk/models/servicing_content_package_dto.py +92 -0
  470. visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py +96 -0
  471. visier_platform_sdk/models/servicing_data_access_set_dto.py +104 -0
  472. visier_platform_sdk/models/servicing_data_access_set_error_dto.py +90 -0
  473. visier_platform_sdk/models/servicing_data_access_set_failure_dto.py +96 -0
  474. visier_platform_sdk/models/servicing_data_access_set_success_dto.py +90 -0
  475. visier_platform_sdk/models/servicing_data_categories_response_dto.py +96 -0
  476. visier_platform_sdk/models/servicing_data_category_response_dto.py +90 -0
  477. visier_platform_sdk/models/servicing_data_security_profile_dto.py +134 -0
  478. visier_platform_sdk/models/servicing_delete_permissions_request_dto.py +88 -0
  479. visier_platform_sdk/models/servicing_dimension_filter_dto.py +98 -0
  480. visier_platform_sdk/models/servicing_direct_data_job_config_dto.py +100 -0
  481. visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py +96 -0
  482. visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py +96 -0
  483. visier_platform_sdk/models/servicing_direct_data_load_config_dto.py +92 -0
  484. visier_platform_sdk/models/servicing_direct_data_schema_dto.py +96 -0
  485. visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py +96 -0
  486. visier_platform_sdk/models/servicing_direct_data_transaction_dto.py +96 -0
  487. visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py +88 -0
  488. visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +92 -0
  489. visier_platform_sdk/models/servicing_document_search_link_dto.py +90 -0
  490. visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py +112 -0
  491. visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py +106 -0
  492. visier_platform_sdk/models/servicing_error_dto.py +92 -0
  493. visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py +92 -0
  494. visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py +98 -0
  495. visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py +94 -0
  496. visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py +90 -0
  497. visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py +96 -0
  498. visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py +96 -0
  499. visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py +96 -0
  500. visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py +96 -0
  501. visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py +96 -0
  502. visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py +96 -0
  503. visier_platform_sdk/models/servicing_get_projects_api_response_dto.py +123 -0
  504. visier_platform_sdk/models/servicing_hierarchy_property_dto.py +90 -0
  505. visier_platform_sdk/models/servicing_inherited_access_config_dto.py +100 -0
  506. visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py +90 -0
  507. visier_platform_sdk/models/servicing_job_id_response.py +88 -0
  508. visier_platform_sdk/models/servicing_last_login_dto.py +88 -0
  509. visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py +92 -0
  510. visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py +118 -0
  511. visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py +88 -0
  512. visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py +106 -0
  513. visier_platform_sdk/models/servicing_member_filter_config_dto.py +96 -0
  514. visier_platform_sdk/models/servicing_member_selection_dto.py +102 -0
  515. visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py +90 -0
  516. visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py +92 -0
  517. visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py +94 -0
  518. visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py +100 -0
  519. visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py +96 -0
  520. visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py +98 -0
  521. visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py +94 -0
  522. visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py +106 -0
  523. visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py +96 -0
  524. visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py +100 -0
  525. visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py +106 -0
  526. visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py +112 -0
  527. visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py +100 -0
  528. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py +92 -0
  529. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py +117 -0
  530. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py +113 -0
  531. visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py +98 -0
  532. visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py +88 -0
  533. visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py +88 -0
  534. visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py +98 -0
  535. visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py +92 -0
  536. visier_platform_sdk/models/servicing_permission_assigned_user_dto.py +92 -0
  537. visier_platform_sdk/models/servicing_permission_assigned_users_dto.py +100 -0
  538. visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py +106 -0
  539. visier_platform_sdk/models/servicing_permission_dto.py +114 -0
  540. visier_platform_sdk/models/servicing_permission_error_dto.py +90 -0
  541. visier_platform_sdk/models/servicing_permission_failure_dto.py +96 -0
  542. visier_platform_sdk/models/servicing_permission_success_dto.py +90 -0
  543. visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py +98 -0
  544. visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py +92 -0
  545. visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py +104 -0
  546. visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py +88 -0
  547. visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py +98 -0
  548. visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py +110 -0
  549. visier_platform_sdk/models/servicing_profile_get_api_response_dto.py +102 -0
  550. visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py +96 -0
  551. visier_platform_sdk/models/servicing_project_commits_api_response_dto.py +96 -0
  552. visier_platform_sdk/models/servicing_project_dto.py +111 -0
  553. visier_platform_sdk/models/servicing_project_operation_request_dto.py +98 -0
  554. visier_platform_sdk/models/servicing_project_operation_response_dto.py +92 -0
  555. visier_platform_sdk/models/servicing_property_access_config_dto.py +116 -0
  556. visier_platform_sdk/models/servicing_property_set_config_dto.py +102 -0
  557. visier_platform_sdk/models/servicing_question_categories_api_response_dto.py +96 -0
  558. visier_platform_sdk/models/servicing_question_category_api_response_dto.py +90 -0
  559. visier_platform_sdk/models/servicing_reduced_error_dto.py +88 -0
  560. visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py +96 -0
  561. visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py +94 -0
  562. visier_platform_sdk/models/servicing_related_analytic_object_dto.py +90 -0
  563. visier_platform_sdk/models/servicing_role_modules_config_dto.py +88 -0
  564. visier_platform_sdk/models/servicing_sample_question_api_response_dto.py +100 -0
  565. visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py +96 -0
  566. visier_platform_sdk/models/servicing_securable_dimension_dto.py +102 -0
  567. visier_platform_sdk/models/servicing_securable_property_dto.py +96 -0
  568. visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py +96 -0
  569. visier_platform_sdk/models/servicing_shareable_data_access_set.py +88 -0
  570. visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py +96 -0
  571. visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py +98 -0
  572. visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py +98 -0
  573. visier_platform_sdk/models/servicing_static_dimension_filter_dto.py +112 -0
  574. visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py +92 -0
  575. visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py +88 -0
  576. visier_platform_sdk/models/servicing_target_tenant_code_dto.py +90 -0
  577. visier_platform_sdk/models/servicing_tenant_code_error_dto.py +96 -0
  578. visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py +90 -0
  579. visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py +94 -0
  580. visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py +100 -0
  581. visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py +98 -0
  582. visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py +100 -0
  583. visier_platform_sdk/models/servicing_user_creation_api_request_dto.py +96 -0
  584. visier_platform_sdk/models/servicing_user_get_api_response_dto.py +122 -0
  585. visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py +90 -0
  586. visier_platform_sdk/models/servicing_user_group_assignment_dto.py +88 -0
  587. visier_platform_sdk/models/servicing_user_id_error_dto.py +94 -0
  588. visier_platform_sdk/models/servicing_user_property_dto.py +88 -0
  589. visier_platform_sdk/models/servicing_user_update_api_request_dto.py +96 -0
  590. visier_platform_sdk/models/servicing_users_api_error_message_dto.py +90 -0
  591. visier_platform_sdk/models/servicing_users_api_failure_dto.py +98 -0
  592. visier_platform_sdk/models/servicing_users_api_response_dto.py +106 -0
  593. visier_platform_sdk/models/servicing_users_api_success_dto.py +98 -0
  594. visier_platform_sdk/models/servicing_users_creation_api_request_dto.py +96 -0
  595. visier_platform_sdk/models/servicing_users_delete_api_request_dto.py +88 -0
  596. visier_platform_sdk/models/servicing_users_update_api_request_dto.py +96 -0
  597. visier_platform_sdk/models/servicing_users_update_api_user_dto.py +98 -0
  598. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py +102 -0
  599. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py +96 -0
  600. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py +98 -0
  601. visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py +102 -0
  602. visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py +106 -0
  603. visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py +92 -0
  604. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py +102 -0
  605. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py +96 -0
  606. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py +98 -0
  607. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py +96 -0
  608. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py +96 -0
  609. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py +92 -0
  610. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py +98 -0
  611. visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py +90 -0
  612. visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py +100 -0
  613. visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py +114 -0
  614. visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py +92 -0
  615. visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py +90 -0
  616. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py +128 -0
  617. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py +90 -0
  618. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py +96 -0
  619. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py +92 -0
  620. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py +96 -0
  621. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py +114 -0
  622. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py +96 -0
  623. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py +96 -0
  624. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py +92 -0
  625. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py +102 -0
  626. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py +96 -0
  627. visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py +102 -0
  628. visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py +104 -0
  629. visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py +90 -0
  630. visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py +98 -0
  631. visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py +88 -0
  632. visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py +88 -0
  633. visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py +96 -0
  634. visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py +100 -0
  635. visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py +100 -0
  636. visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py +106 -0
  637. visier_platform_sdk/models/servicing_vee_question_change_success_dto.py +104 -0
  638. visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py +92 -0
  639. visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py +106 -0
  640. visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py +96 -0
  641. visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py +96 -0
  642. visier_platform_sdk/models/skill.py +106 -0
  643. visier_platform_sdk/models/skill_category.py +102 -0
  644. visier_platform_sdk/models/skill_category_entry.py +92 -0
  645. visier_platform_sdk/models/skill_entry.py +92 -0
  646. visier_platform_sdk/models/skill_extraction_input.py +93 -0
  647. visier_platform_sdk/models/skill_group.py +104 -0
  648. visier_platform_sdk/models/skill_group_entry.py +92 -0
  649. visier_platform_sdk/models/skill_match_input.py +91 -0
  650. visier_platform_sdk/models/source_import_result_summary_dto.py +94 -0
  651. visier_platform_sdk/models/sources_api_put_response_dto.py +92 -0
  652. visier_platform_sdk/models/sql_like200_response.py +138 -0
  653. visier_platform_sdk/models/status.py +96 -0
  654. visier_platform_sdk/models/systemstatus_system_status_dto.py +88 -0
  655. visier_platform_sdk/models/systemstatus_vee_status_dto.py +88 -0
  656. visier_platform_sdk/models/table_response_dto.py +90 -0
  657. visier_platform_sdk/models/token_response.py +96 -0
  658. visier_platform_sdk/models/user_creation_api_response_dto.py +98 -0
  659. visier_platform_sdk/py.typed +0 -0
  660. visier_platform_sdk/rest.py +259 -0
  661. visier_platform_sdk-22222222.99201.1892b3.dist-info/METADATA +25 -0
  662. visier_platform_sdk-22222222.99201.1892b3.dist-info/RECORD +664 -0
  663. visier_platform_sdk-22222222.99201.1892b3.dist-info/WHEEL +5 -0
  664. visier_platform_sdk-22222222.99201.1892b3.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2836 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ API Reference
5
+
6
+ Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
7
+
8
+ The version of the OpenAPI document: 22222222.99201.1892
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, StrictBool, StrictInt, StrictStr
21
+ from typing import Optional
22
+ from typing_extensions import Annotated
23
+ from visier_platform_sdk.models.admin_all_tenants_status_apidto import AdminAllTenantsStatusAPIDTO
24
+ from visier_platform_sdk.models.admin_batch_tenant_provision_apidto import AdminBatchTenantProvisionAPIDTO
25
+ from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO
26
+ from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO
27
+ from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO
28
+ from visier_platform_sdk.models.admin_update_tenant_model import AdminUpdateTenantModel
29
+ from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO
30
+ from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_list_dto import DpAutomationTenantPreviewEntriesSummaryListDTO
31
+
32
+ from visier_platform_sdk.api_client import ApiClient, RequestSerialized
33
+ from visier_platform_sdk.api_response import ApiResponse
34
+ from visier_platform_sdk.rest import RESTResponseType
35
+
36
+
37
+ class TenantsV1Api:
38
+ """NOTE: This class is auto generated by OpenAPI Generator
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+ """
43
+
44
+ def __init__(self, api_client=None) -> None:
45
+ if api_client is None:
46
+ api_client = ApiClient.get_default()
47
+ self.api_client = api_client
48
+
49
+
50
+ @validate_call
51
+ def add_tenant(
52
+ self,
53
+ admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO,
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
+ ) -> AdminTenantProvisionAPIDTO:
67
+ """Add an analytic tenant
68
+
69
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you.
70
+
71
+ :param admin_tenant_provision_apidto: (required)
72
+ :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO
73
+ :param _request_timeout: timeout setting for this request. If one
74
+ number provided, it will be total request
75
+ timeout. It can also be a pair (tuple) of
76
+ (connection, read) timeouts.
77
+ :type _request_timeout: int, tuple(int, int), optional
78
+ :param _request_auth: set to override the auth_settings for an a single
79
+ request; this effectively ignores the
80
+ authentication in the spec for a single request.
81
+ :type _request_auth: dict, optional
82
+ :param _content_type: force content-type for the request.
83
+ :type _content_type: str, Optional
84
+ :param _headers: set to override the headers for a single
85
+ request; this effectively ignores the headers
86
+ in the spec for a single request.
87
+ :type _headers: dict, optional
88
+ :param _host_index: set to override the host_index for a single
89
+ request; this effectively ignores the host_index
90
+ in the spec for a single request.
91
+ :type _host_index: int, optional
92
+ :return: Returns the result object.
93
+ """ # noqa: E501
94
+
95
+ _param = self._add_tenant_serialize(
96
+ admin_tenant_provision_apidto=admin_tenant_provision_apidto,
97
+ _request_auth=_request_auth,
98
+ _content_type=_content_type,
99
+ _headers=_headers,
100
+ _host_index=_host_index
101
+ )
102
+
103
+ _response_types_map: Dict[str, Optional[str]] = {
104
+ '200': "AdminTenantProvisionAPIDTO",
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def add_tenant_with_http_info(
119
+ self,
120
+ admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO,
121
+ _request_timeout: Union[
122
+ None,
123
+ Annotated[StrictFloat, Field(gt=0)],
124
+ Tuple[
125
+ Annotated[StrictFloat, Field(gt=0)],
126
+ Annotated[StrictFloat, Field(gt=0)]
127
+ ]
128
+ ] = None,
129
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
130
+ _content_type: Optional[StrictStr] = None,
131
+ _headers: Optional[Dict[StrictStr, Any]] = None,
132
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
133
+ ) -> ApiResponse[AdminTenantProvisionAPIDTO]:
134
+ """Add an analytic tenant
135
+
136
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you.
137
+
138
+ :param admin_tenant_provision_apidto: (required)
139
+ :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO
140
+ :param _request_timeout: timeout setting for this request. If one
141
+ number provided, it will be total request
142
+ timeout. It can also be a pair (tuple) of
143
+ (connection, read) timeouts.
144
+ :type _request_timeout: int, tuple(int, int), optional
145
+ :param _request_auth: set to override the auth_settings for an a single
146
+ request; this effectively ignores the
147
+ authentication in the spec for a single request.
148
+ :type _request_auth: dict, optional
149
+ :param _content_type: force content-type for the request.
150
+ :type _content_type: str, Optional
151
+ :param _headers: set to override the headers for a single
152
+ request; this effectively ignores the headers
153
+ in the spec for a single request.
154
+ :type _headers: dict, optional
155
+ :param _host_index: set to override the host_index for a single
156
+ request; this effectively ignores the host_index
157
+ in the spec for a single request.
158
+ :type _host_index: int, optional
159
+ :return: Returns the result object.
160
+ """ # noqa: E501
161
+
162
+ _param = self._add_tenant_serialize(
163
+ admin_tenant_provision_apidto=admin_tenant_provision_apidto,
164
+ _request_auth=_request_auth,
165
+ _content_type=_content_type,
166
+ _headers=_headers,
167
+ _host_index=_host_index
168
+ )
169
+
170
+ _response_types_map: Dict[str, Optional[str]] = {
171
+ '200': "AdminTenantProvisionAPIDTO",
172
+ }
173
+ response_data = self.api_client.call_api(
174
+ *_param,
175
+ _request_timeout=_request_timeout
176
+ )
177
+ response_data.read()
178
+ return self.api_client.response_deserialize(
179
+ response_data=response_data,
180
+ response_types_map=_response_types_map,
181
+ )
182
+
183
+
184
+ @validate_call
185
+ def add_tenant_without_preload_content(
186
+ self,
187
+ admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO,
188
+ _request_timeout: Union[
189
+ None,
190
+ Annotated[StrictFloat, Field(gt=0)],
191
+ Tuple[
192
+ Annotated[StrictFloat, Field(gt=0)],
193
+ Annotated[StrictFloat, Field(gt=0)]
194
+ ]
195
+ ] = None,
196
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
197
+ _content_type: Optional[StrictStr] = None,
198
+ _headers: Optional[Dict[StrictStr, Any]] = None,
199
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
200
+ ) -> RESTResponseType:
201
+ """Add an analytic tenant
202
+
203
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you.
204
+
205
+ :param admin_tenant_provision_apidto: (required)
206
+ :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO
207
+ :param _request_timeout: timeout setting for this request. If one
208
+ number provided, it will be total request
209
+ timeout. It can also be a pair (tuple) of
210
+ (connection, read) timeouts.
211
+ :type _request_timeout: int, tuple(int, int), optional
212
+ :param _request_auth: set to override the auth_settings for an a single
213
+ request; this effectively ignores the
214
+ authentication in the spec for a single request.
215
+ :type _request_auth: dict, optional
216
+ :param _content_type: force content-type for the request.
217
+ :type _content_type: str, Optional
218
+ :param _headers: set to override the headers for a single
219
+ request; this effectively ignores the headers
220
+ in the spec for a single request.
221
+ :type _headers: dict, optional
222
+ :param _host_index: set to override the host_index for a single
223
+ request; this effectively ignores the host_index
224
+ in the spec for a single request.
225
+ :type _host_index: int, optional
226
+ :return: Returns the result object.
227
+ """ # noqa: E501
228
+
229
+ _param = self._add_tenant_serialize(
230
+ admin_tenant_provision_apidto=admin_tenant_provision_apidto,
231
+ _request_auth=_request_auth,
232
+ _content_type=_content_type,
233
+ _headers=_headers,
234
+ _host_index=_host_index
235
+ )
236
+
237
+ _response_types_map: Dict[str, Optional[str]] = {
238
+ '200': "AdminTenantProvisionAPIDTO",
239
+ }
240
+ response_data = self.api_client.call_api(
241
+ *_param,
242
+ _request_timeout=_request_timeout
243
+ )
244
+ return response_data.response
245
+
246
+
247
+ def _add_tenant_serialize(
248
+ self,
249
+ admin_tenant_provision_apidto,
250
+ _request_auth,
251
+ _content_type,
252
+ _headers,
253
+ _host_index,
254
+ ) -> RequestSerialized:
255
+
256
+ _host = None
257
+
258
+ _collection_formats: Dict[str, str] = {
259
+ }
260
+
261
+ _path_params: Dict[str, str] = {}
262
+ _query_params: List[Tuple[str, str]] = []
263
+ _header_params: Dict[str, Optional[str]] = _headers or {}
264
+ _form_params: List[Tuple[str, str]] = []
265
+ _files: Dict[
266
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
267
+ ] = {}
268
+ _body_params: Optional[bytes] = None
269
+
270
+ # process the path parameters
271
+ # process the query parameters
272
+ # process the header parameters
273
+ # process the form parameters
274
+ # process the body parameter
275
+ if admin_tenant_provision_apidto is not None:
276
+ _body_params = admin_tenant_provision_apidto
277
+
278
+
279
+ # set the HTTP header `Accept`
280
+ if 'Accept' not in _header_params:
281
+ _header_params['Accept'] = self.api_client.select_header_accept(
282
+ [
283
+ 'application/json'
284
+ ]
285
+ )
286
+
287
+ # set the HTTP header `Content-Type`
288
+ if _content_type:
289
+ _header_params['Content-Type'] = _content_type
290
+ else:
291
+ _default_content_type = (
292
+ self.api_client.select_header_content_type(
293
+ [
294
+ 'application/json'
295
+ ]
296
+ )
297
+ )
298
+ if _default_content_type is not None:
299
+ _header_params['Content-Type'] = _default_content_type
300
+
301
+ # authentication setting
302
+ _auth_settings: List[str] = [
303
+ 'CookieAuth',
304
+ 'ApiKeyAuth',
305
+ 'OAuth2Auth',
306
+ 'OAuth2Auth',
307
+ 'BearerAuth'
308
+ ]
309
+
310
+ return self.api_client.param_serialize(
311
+ method='POST',
312
+ resource_path='/v1/admin/tenants',
313
+ path_params=_path_params,
314
+ query_params=_query_params,
315
+ header_params=_header_params,
316
+ body=_body_params,
317
+ post_params=_form_params,
318
+ files=_files,
319
+ auth_settings=_auth_settings,
320
+ collection_formats=_collection_formats,
321
+ _host=_host,
322
+ _request_auth=_request_auth
323
+ )
324
+
325
+
326
+
327
+
328
+ @validate_call
329
+ def add_tenants(
330
+ self,
331
+ admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO,
332
+ _request_timeout: Union[
333
+ None,
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Tuple[
336
+ Annotated[StrictFloat, Field(gt=0)],
337
+ Annotated[StrictFloat, Field(gt=0)]
338
+ ]
339
+ ] = None,
340
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
341
+ _content_type: Optional[StrictStr] = None,
342
+ _headers: Optional[Dict[StrictStr, Any]] = None,
343
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
344
+ ) -> AdminBatchTenantProvisionAPIDTO:
345
+ """Add analytic tenants
346
+
347
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you.
348
+
349
+ :param admin_batch_tenant_provision_apidto: (required)
350
+ :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO
351
+ :param _request_timeout: timeout setting for this request. If one
352
+ number provided, it will be total request
353
+ timeout. It can also be a pair (tuple) of
354
+ (connection, read) timeouts.
355
+ :type _request_timeout: int, tuple(int, int), optional
356
+ :param _request_auth: set to override the auth_settings for an a single
357
+ request; this effectively ignores the
358
+ authentication in the spec for a single request.
359
+ :type _request_auth: dict, optional
360
+ :param _content_type: force content-type for the request.
361
+ :type _content_type: str, Optional
362
+ :param _headers: set to override the headers for a single
363
+ request; this effectively ignores the headers
364
+ in the spec for a single request.
365
+ :type _headers: dict, optional
366
+ :param _host_index: set to override the host_index for a single
367
+ request; this effectively ignores the host_index
368
+ in the spec for a single request.
369
+ :type _host_index: int, optional
370
+ :return: Returns the result object.
371
+ """ # noqa: E501
372
+
373
+ _param = self._add_tenants_serialize(
374
+ admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto,
375
+ _request_auth=_request_auth,
376
+ _content_type=_content_type,
377
+ _headers=_headers,
378
+ _host_index=_host_index
379
+ )
380
+
381
+ _response_types_map: Dict[str, Optional[str]] = {
382
+ '200': "AdminBatchTenantProvisionAPIDTO",
383
+ }
384
+ response_data = self.api_client.call_api(
385
+ *_param,
386
+ _request_timeout=_request_timeout
387
+ )
388
+ response_data.read()
389
+ return self.api_client.response_deserialize(
390
+ response_data=response_data,
391
+ response_types_map=_response_types_map,
392
+ ).data
393
+
394
+
395
+ @validate_call
396
+ def add_tenants_with_http_info(
397
+ self,
398
+ admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO,
399
+ _request_timeout: Union[
400
+ None,
401
+ Annotated[StrictFloat, Field(gt=0)],
402
+ Tuple[
403
+ Annotated[StrictFloat, Field(gt=0)],
404
+ Annotated[StrictFloat, Field(gt=0)]
405
+ ]
406
+ ] = None,
407
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
408
+ _content_type: Optional[StrictStr] = None,
409
+ _headers: Optional[Dict[StrictStr, Any]] = None,
410
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
411
+ ) -> ApiResponse[AdminBatchTenantProvisionAPIDTO]:
412
+ """Add analytic tenants
413
+
414
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you.
415
+
416
+ :param admin_batch_tenant_provision_apidto: (required)
417
+ :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO
418
+ :param _request_timeout: timeout setting for this request. If one
419
+ number provided, it will be total request
420
+ timeout. It can also be a pair (tuple) of
421
+ (connection, read) timeouts.
422
+ :type _request_timeout: int, tuple(int, int), optional
423
+ :param _request_auth: set to override the auth_settings for an a single
424
+ request; this effectively ignores the
425
+ authentication in the spec for a single request.
426
+ :type _request_auth: dict, optional
427
+ :param _content_type: force content-type for the request.
428
+ :type _content_type: str, Optional
429
+ :param _headers: set to override the headers for a single
430
+ request; this effectively ignores the headers
431
+ in the spec for a single request.
432
+ :type _headers: dict, optional
433
+ :param _host_index: set to override the host_index for a single
434
+ request; this effectively ignores the host_index
435
+ in the spec for a single request.
436
+ :type _host_index: int, optional
437
+ :return: Returns the result object.
438
+ """ # noqa: E501
439
+
440
+ _param = self._add_tenants_serialize(
441
+ admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto,
442
+ _request_auth=_request_auth,
443
+ _content_type=_content_type,
444
+ _headers=_headers,
445
+ _host_index=_host_index
446
+ )
447
+
448
+ _response_types_map: Dict[str, Optional[str]] = {
449
+ '200': "AdminBatchTenantProvisionAPIDTO",
450
+ }
451
+ response_data = self.api_client.call_api(
452
+ *_param,
453
+ _request_timeout=_request_timeout
454
+ )
455
+ response_data.read()
456
+ return self.api_client.response_deserialize(
457
+ response_data=response_data,
458
+ response_types_map=_response_types_map,
459
+ )
460
+
461
+
462
+ @validate_call
463
+ def add_tenants_without_preload_content(
464
+ self,
465
+ admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO,
466
+ _request_timeout: Union[
467
+ None,
468
+ Annotated[StrictFloat, Field(gt=0)],
469
+ Tuple[
470
+ Annotated[StrictFloat, Field(gt=0)],
471
+ Annotated[StrictFloat, Field(gt=0)]
472
+ ]
473
+ ] = None,
474
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
475
+ _content_type: Optional[StrictStr] = None,
476
+ _headers: Optional[Dict[StrictStr, Any]] = None,
477
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
478
+ ) -> RESTResponseType:
479
+ """Add analytic tenants
480
+
481
+ Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you.
482
+
483
+ :param admin_batch_tenant_provision_apidto: (required)
484
+ :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO
485
+ :param _request_timeout: timeout setting for this request. If one
486
+ number provided, it will be total request
487
+ timeout. It can also be a pair (tuple) of
488
+ (connection, read) timeouts.
489
+ :type _request_timeout: int, tuple(int, int), optional
490
+ :param _request_auth: set to override the auth_settings for an a single
491
+ request; this effectively ignores the
492
+ authentication in the spec for a single request.
493
+ :type _request_auth: dict, optional
494
+ :param _content_type: force content-type for the request.
495
+ :type _content_type: str, Optional
496
+ :param _headers: set to override the headers for a single
497
+ request; this effectively ignores the headers
498
+ in the spec for a single request.
499
+ :type _headers: dict, optional
500
+ :param _host_index: set to override the host_index for a single
501
+ request; this effectively ignores the host_index
502
+ in the spec for a single request.
503
+ :type _host_index: int, optional
504
+ :return: Returns the result object.
505
+ """ # noqa: E501
506
+
507
+ _param = self._add_tenants_serialize(
508
+ admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto,
509
+ _request_auth=_request_auth,
510
+ _content_type=_content_type,
511
+ _headers=_headers,
512
+ _host_index=_host_index
513
+ )
514
+
515
+ _response_types_map: Dict[str, Optional[str]] = {
516
+ '200': "AdminBatchTenantProvisionAPIDTO",
517
+ }
518
+ response_data = self.api_client.call_api(
519
+ *_param,
520
+ _request_timeout=_request_timeout
521
+ )
522
+ return response_data.response
523
+
524
+
525
+ def _add_tenants_serialize(
526
+ self,
527
+ admin_batch_tenant_provision_apidto,
528
+ _request_auth,
529
+ _content_type,
530
+ _headers,
531
+ _host_index,
532
+ ) -> RequestSerialized:
533
+
534
+ _host = None
535
+
536
+ _collection_formats: Dict[str, str] = {
537
+ }
538
+
539
+ _path_params: Dict[str, str] = {}
540
+ _query_params: List[Tuple[str, str]] = []
541
+ _header_params: Dict[str, Optional[str]] = _headers or {}
542
+ _form_params: List[Tuple[str, str]] = []
543
+ _files: Dict[
544
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
545
+ ] = {}
546
+ _body_params: Optional[bytes] = None
547
+
548
+ # process the path parameters
549
+ # process the query parameters
550
+ # process the header parameters
551
+ # process the form parameters
552
+ # process the body parameter
553
+ if admin_batch_tenant_provision_apidto is not None:
554
+ _body_params = admin_batch_tenant_provision_apidto
555
+
556
+
557
+ # set the HTTP header `Accept`
558
+ if 'Accept' not in _header_params:
559
+ _header_params['Accept'] = self.api_client.select_header_accept(
560
+ [
561
+ 'application/json'
562
+ ]
563
+ )
564
+
565
+ # set the HTTP header `Content-Type`
566
+ if _content_type:
567
+ _header_params['Content-Type'] = _content_type
568
+ else:
569
+ _default_content_type = (
570
+ self.api_client.select_header_content_type(
571
+ [
572
+ 'application/json'
573
+ ]
574
+ )
575
+ )
576
+ if _default_content_type is not None:
577
+ _header_params['Content-Type'] = _default_content_type
578
+
579
+ # authentication setting
580
+ _auth_settings: List[str] = [
581
+ 'CookieAuth',
582
+ 'ApiKeyAuth',
583
+ 'OAuth2Auth',
584
+ 'OAuth2Auth',
585
+ 'BearerAuth'
586
+ ]
587
+
588
+ return self.api_client.param_serialize(
589
+ method='POST',
590
+ resource_path='/v1/admin/tenants/batch',
591
+ path_params=_path_params,
592
+ query_params=_query_params,
593
+ header_params=_header_params,
594
+ body=_body_params,
595
+ post_params=_form_params,
596
+ files=_files,
597
+ auth_settings=_auth_settings,
598
+ collection_formats=_collection_formats,
599
+ _host=_host,
600
+ _request_auth=_request_auth
601
+ )
602
+
603
+
604
+
605
+
606
+ @validate_call
607
+ def delete_tenant(
608
+ self,
609
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
610
+ _request_timeout: Union[
611
+ None,
612
+ Annotated[StrictFloat, Field(gt=0)],
613
+ Tuple[
614
+ Annotated[StrictFloat, Field(gt=0)],
615
+ Annotated[StrictFloat, Field(gt=0)]
616
+ ]
617
+ ] = None,
618
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
619
+ _content_type: Optional[StrictStr] = None,
620
+ _headers: Optional[Dict[StrictStr, Any]] = None,
621
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
622
+ ) -> AdminTenantStatusAPIDTO:
623
+ """Deprovision an analytic tenant
624
+
625
+ Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete.
626
+
627
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
628
+ :type tenant_id: str
629
+ :param _request_timeout: timeout setting for this request. If one
630
+ number provided, it will be total request
631
+ timeout. It can also be a pair (tuple) of
632
+ (connection, read) timeouts.
633
+ :type _request_timeout: int, tuple(int, int), optional
634
+ :param _request_auth: set to override the auth_settings for an a single
635
+ request; this effectively ignores the
636
+ authentication in the spec for a single request.
637
+ :type _request_auth: dict, optional
638
+ :param _content_type: force content-type for the request.
639
+ :type _content_type: str, Optional
640
+ :param _headers: set to override the headers for a single
641
+ request; this effectively ignores the headers
642
+ in the spec for a single request.
643
+ :type _headers: dict, optional
644
+ :param _host_index: set to override the host_index for a single
645
+ request; this effectively ignores the host_index
646
+ in the spec for a single request.
647
+ :type _host_index: int, optional
648
+ :return: Returns the result object.
649
+ """ # noqa: E501
650
+
651
+ _param = self._delete_tenant_serialize(
652
+ tenant_id=tenant_id,
653
+ _request_auth=_request_auth,
654
+ _content_type=_content_type,
655
+ _headers=_headers,
656
+ _host_index=_host_index
657
+ )
658
+
659
+ _response_types_map: Dict[str, Optional[str]] = {
660
+ '200': "AdminTenantStatusAPIDTO",
661
+ }
662
+ response_data = self.api_client.call_api(
663
+ *_param,
664
+ _request_timeout=_request_timeout
665
+ )
666
+ response_data.read()
667
+ return self.api_client.response_deserialize(
668
+ response_data=response_data,
669
+ response_types_map=_response_types_map,
670
+ ).data
671
+
672
+
673
+ @validate_call
674
+ def delete_tenant_with_http_info(
675
+ self,
676
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
677
+ _request_timeout: Union[
678
+ None,
679
+ Annotated[StrictFloat, Field(gt=0)],
680
+ Tuple[
681
+ Annotated[StrictFloat, Field(gt=0)],
682
+ Annotated[StrictFloat, Field(gt=0)]
683
+ ]
684
+ ] = None,
685
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
686
+ _content_type: Optional[StrictStr] = None,
687
+ _headers: Optional[Dict[StrictStr, Any]] = None,
688
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
689
+ ) -> ApiResponse[AdminTenantStatusAPIDTO]:
690
+ """Deprovision an analytic tenant
691
+
692
+ Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete.
693
+
694
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
695
+ :type tenant_id: str
696
+ :param _request_timeout: timeout setting for this request. If one
697
+ number provided, it will be total request
698
+ timeout. It can also be a pair (tuple) of
699
+ (connection, read) timeouts.
700
+ :type _request_timeout: int, tuple(int, int), optional
701
+ :param _request_auth: set to override the auth_settings for an a single
702
+ request; this effectively ignores the
703
+ authentication in the spec for a single request.
704
+ :type _request_auth: dict, optional
705
+ :param _content_type: force content-type for the request.
706
+ :type _content_type: str, Optional
707
+ :param _headers: set to override the headers for a single
708
+ request; this effectively ignores the headers
709
+ in the spec for a single request.
710
+ :type _headers: dict, optional
711
+ :param _host_index: set to override the host_index for a single
712
+ request; this effectively ignores the host_index
713
+ in the spec for a single request.
714
+ :type _host_index: int, optional
715
+ :return: Returns the result object.
716
+ """ # noqa: E501
717
+
718
+ _param = self._delete_tenant_serialize(
719
+ tenant_id=tenant_id,
720
+ _request_auth=_request_auth,
721
+ _content_type=_content_type,
722
+ _headers=_headers,
723
+ _host_index=_host_index
724
+ )
725
+
726
+ _response_types_map: Dict[str, Optional[str]] = {
727
+ '200': "AdminTenantStatusAPIDTO",
728
+ }
729
+ response_data = self.api_client.call_api(
730
+ *_param,
731
+ _request_timeout=_request_timeout
732
+ )
733
+ response_data.read()
734
+ return self.api_client.response_deserialize(
735
+ response_data=response_data,
736
+ response_types_map=_response_types_map,
737
+ )
738
+
739
+
740
+ @validate_call
741
+ def delete_tenant_without_preload_content(
742
+ self,
743
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
744
+ _request_timeout: Union[
745
+ None,
746
+ Annotated[StrictFloat, Field(gt=0)],
747
+ Tuple[
748
+ Annotated[StrictFloat, Field(gt=0)],
749
+ Annotated[StrictFloat, Field(gt=0)]
750
+ ]
751
+ ] = None,
752
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
753
+ _content_type: Optional[StrictStr] = None,
754
+ _headers: Optional[Dict[StrictStr, Any]] = None,
755
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
756
+ ) -> RESTResponseType:
757
+ """Deprovision an analytic tenant
758
+
759
+ Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete.
760
+
761
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
762
+ :type tenant_id: str
763
+ :param _request_timeout: timeout setting for this request. If one
764
+ number provided, it will be total request
765
+ timeout. It can also be a pair (tuple) of
766
+ (connection, read) timeouts.
767
+ :type _request_timeout: int, tuple(int, int), optional
768
+ :param _request_auth: set to override the auth_settings for an a single
769
+ request; this effectively ignores the
770
+ authentication in the spec for a single request.
771
+ :type _request_auth: dict, optional
772
+ :param _content_type: force content-type for the request.
773
+ :type _content_type: str, Optional
774
+ :param _headers: set to override the headers for a single
775
+ request; this effectively ignores the headers
776
+ in the spec for a single request.
777
+ :type _headers: dict, optional
778
+ :param _host_index: set to override the host_index for a single
779
+ request; this effectively ignores the host_index
780
+ in the spec for a single request.
781
+ :type _host_index: int, optional
782
+ :return: Returns the result object.
783
+ """ # noqa: E501
784
+
785
+ _param = self._delete_tenant_serialize(
786
+ tenant_id=tenant_id,
787
+ _request_auth=_request_auth,
788
+ _content_type=_content_type,
789
+ _headers=_headers,
790
+ _host_index=_host_index
791
+ )
792
+
793
+ _response_types_map: Dict[str, Optional[str]] = {
794
+ '200': "AdminTenantStatusAPIDTO",
795
+ }
796
+ response_data = self.api_client.call_api(
797
+ *_param,
798
+ _request_timeout=_request_timeout
799
+ )
800
+ return response_data.response
801
+
802
+
803
+ def _delete_tenant_serialize(
804
+ self,
805
+ tenant_id,
806
+ _request_auth,
807
+ _content_type,
808
+ _headers,
809
+ _host_index,
810
+ ) -> RequestSerialized:
811
+
812
+ _host = None
813
+
814
+ _collection_formats: Dict[str, str] = {
815
+ }
816
+
817
+ _path_params: Dict[str, str] = {}
818
+ _query_params: List[Tuple[str, str]] = []
819
+ _header_params: Dict[str, Optional[str]] = _headers or {}
820
+ _form_params: List[Tuple[str, str]] = []
821
+ _files: Dict[
822
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
823
+ ] = {}
824
+ _body_params: Optional[bytes] = None
825
+
826
+ # process the path parameters
827
+ if tenant_id is not None:
828
+ _path_params['tenantId'] = tenant_id
829
+ # process the query parameters
830
+ # process the header parameters
831
+ # process the form parameters
832
+ # process the body parameter
833
+
834
+
835
+ # set the HTTP header `Accept`
836
+ if 'Accept' not in _header_params:
837
+ _header_params['Accept'] = self.api_client.select_header_accept(
838
+ [
839
+ 'application/json'
840
+ ]
841
+ )
842
+
843
+
844
+ # authentication setting
845
+ _auth_settings: List[str] = [
846
+ 'CookieAuth',
847
+ 'ApiKeyAuth',
848
+ 'OAuth2Auth',
849
+ 'OAuth2Auth',
850
+ 'BearerAuth'
851
+ ]
852
+
853
+ return self.api_client.param_serialize(
854
+ method='DELETE',
855
+ resource_path='/v1/admin/tenants/{tenantId}',
856
+ path_params=_path_params,
857
+ query_params=_query_params,
858
+ header_params=_header_params,
859
+ body=_body_params,
860
+ post_params=_form_params,
861
+ files=_files,
862
+ auth_settings=_auth_settings,
863
+ collection_formats=_collection_formats,
864
+ _host=_host,
865
+ _request_auth=_request_auth
866
+ )
867
+
868
+
869
+
870
+
871
+ @validate_call
872
+ def disable_tenant(
873
+ self,
874
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
875
+ _request_timeout: Union[
876
+ None,
877
+ Annotated[StrictFloat, Field(gt=0)],
878
+ Tuple[
879
+ Annotated[StrictFloat, Field(gt=0)],
880
+ Annotated[StrictFloat, Field(gt=0)]
881
+ ]
882
+ ] = None,
883
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
884
+ _content_type: Optional[StrictStr] = None,
885
+ _headers: Optional[Dict[StrictStr, Any]] = None,
886
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
887
+ ) -> AdminTenantStatusAPIDTO:
888
+ """Disable an analytic tenant
889
+
890
+ Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system.
891
+
892
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
893
+ :type tenant_id: str
894
+ :param _request_timeout: timeout setting for this request. If one
895
+ number provided, it will be total request
896
+ timeout. It can also be a pair (tuple) of
897
+ (connection, read) timeouts.
898
+ :type _request_timeout: int, tuple(int, int), optional
899
+ :param _request_auth: set to override the auth_settings for an a single
900
+ request; this effectively ignores the
901
+ authentication in the spec for a single request.
902
+ :type _request_auth: dict, optional
903
+ :param _content_type: force content-type for the request.
904
+ :type _content_type: str, Optional
905
+ :param _headers: set to override the headers for a single
906
+ request; this effectively ignores the headers
907
+ in the spec for a single request.
908
+ :type _headers: dict, optional
909
+ :param _host_index: set to override the host_index for a single
910
+ request; this effectively ignores the host_index
911
+ in the spec for a single request.
912
+ :type _host_index: int, optional
913
+ :return: Returns the result object.
914
+ """ # noqa: E501
915
+
916
+ _param = self._disable_tenant_serialize(
917
+ tenant_id=tenant_id,
918
+ _request_auth=_request_auth,
919
+ _content_type=_content_type,
920
+ _headers=_headers,
921
+ _host_index=_host_index
922
+ )
923
+
924
+ _response_types_map: Dict[str, Optional[str]] = {
925
+ '200': "AdminTenantStatusAPIDTO",
926
+ }
927
+ response_data = self.api_client.call_api(
928
+ *_param,
929
+ _request_timeout=_request_timeout
930
+ )
931
+ response_data.read()
932
+ return self.api_client.response_deserialize(
933
+ response_data=response_data,
934
+ response_types_map=_response_types_map,
935
+ ).data
936
+
937
+
938
+ @validate_call
939
+ def disable_tenant_with_http_info(
940
+ self,
941
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
942
+ _request_timeout: Union[
943
+ None,
944
+ Annotated[StrictFloat, Field(gt=0)],
945
+ Tuple[
946
+ Annotated[StrictFloat, Field(gt=0)],
947
+ Annotated[StrictFloat, Field(gt=0)]
948
+ ]
949
+ ] = None,
950
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
951
+ _content_type: Optional[StrictStr] = None,
952
+ _headers: Optional[Dict[StrictStr, Any]] = None,
953
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
954
+ ) -> ApiResponse[AdminTenantStatusAPIDTO]:
955
+ """Disable an analytic tenant
956
+
957
+ Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system.
958
+
959
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
960
+ :type tenant_id: str
961
+ :param _request_timeout: timeout setting for this request. If one
962
+ number provided, it will be total request
963
+ timeout. It can also be a pair (tuple) of
964
+ (connection, read) timeouts.
965
+ :type _request_timeout: int, tuple(int, int), optional
966
+ :param _request_auth: set to override the auth_settings for an a single
967
+ request; this effectively ignores the
968
+ authentication in the spec for a single request.
969
+ :type _request_auth: dict, optional
970
+ :param _content_type: force content-type for the request.
971
+ :type _content_type: str, Optional
972
+ :param _headers: set to override the headers for a single
973
+ request; this effectively ignores the headers
974
+ in the spec for a single request.
975
+ :type _headers: dict, optional
976
+ :param _host_index: set to override the host_index for a single
977
+ request; this effectively ignores the host_index
978
+ in the spec for a single request.
979
+ :type _host_index: int, optional
980
+ :return: Returns the result object.
981
+ """ # noqa: E501
982
+
983
+ _param = self._disable_tenant_serialize(
984
+ tenant_id=tenant_id,
985
+ _request_auth=_request_auth,
986
+ _content_type=_content_type,
987
+ _headers=_headers,
988
+ _host_index=_host_index
989
+ )
990
+
991
+ _response_types_map: Dict[str, Optional[str]] = {
992
+ '200': "AdminTenantStatusAPIDTO",
993
+ }
994
+ response_data = self.api_client.call_api(
995
+ *_param,
996
+ _request_timeout=_request_timeout
997
+ )
998
+ response_data.read()
999
+ return self.api_client.response_deserialize(
1000
+ response_data=response_data,
1001
+ response_types_map=_response_types_map,
1002
+ )
1003
+
1004
+
1005
+ @validate_call
1006
+ def disable_tenant_without_preload_content(
1007
+ self,
1008
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1009
+ _request_timeout: Union[
1010
+ None,
1011
+ Annotated[StrictFloat, Field(gt=0)],
1012
+ Tuple[
1013
+ Annotated[StrictFloat, Field(gt=0)],
1014
+ Annotated[StrictFloat, Field(gt=0)]
1015
+ ]
1016
+ ] = None,
1017
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1018
+ _content_type: Optional[StrictStr] = None,
1019
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1020
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1021
+ ) -> RESTResponseType:
1022
+ """Disable an analytic tenant
1023
+
1024
+ Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system.
1025
+
1026
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1027
+ :type tenant_id: str
1028
+ :param _request_timeout: timeout setting for this request. If one
1029
+ number provided, it will be total request
1030
+ timeout. It can also be a pair (tuple) of
1031
+ (connection, read) timeouts.
1032
+ :type _request_timeout: int, tuple(int, int), optional
1033
+ :param _request_auth: set to override the auth_settings for an a single
1034
+ request; this effectively ignores the
1035
+ authentication in the spec for a single request.
1036
+ :type _request_auth: dict, optional
1037
+ :param _content_type: force content-type for the request.
1038
+ :type _content_type: str, Optional
1039
+ :param _headers: set to override the headers for a single
1040
+ request; this effectively ignores the headers
1041
+ in the spec for a single request.
1042
+ :type _headers: dict, optional
1043
+ :param _host_index: set to override the host_index for a single
1044
+ request; this effectively ignores the host_index
1045
+ in the spec for a single request.
1046
+ :type _host_index: int, optional
1047
+ :return: Returns the result object.
1048
+ """ # noqa: E501
1049
+
1050
+ _param = self._disable_tenant_serialize(
1051
+ tenant_id=tenant_id,
1052
+ _request_auth=_request_auth,
1053
+ _content_type=_content_type,
1054
+ _headers=_headers,
1055
+ _host_index=_host_index
1056
+ )
1057
+
1058
+ _response_types_map: Dict[str, Optional[str]] = {
1059
+ '200': "AdminTenantStatusAPIDTO",
1060
+ }
1061
+ response_data = self.api_client.call_api(
1062
+ *_param,
1063
+ _request_timeout=_request_timeout
1064
+ )
1065
+ return response_data.response
1066
+
1067
+
1068
+ def _disable_tenant_serialize(
1069
+ self,
1070
+ tenant_id,
1071
+ _request_auth,
1072
+ _content_type,
1073
+ _headers,
1074
+ _host_index,
1075
+ ) -> RequestSerialized:
1076
+
1077
+ _host = None
1078
+
1079
+ _collection_formats: Dict[str, str] = {
1080
+ }
1081
+
1082
+ _path_params: Dict[str, str] = {}
1083
+ _query_params: List[Tuple[str, str]] = []
1084
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1085
+ _form_params: List[Tuple[str, str]] = []
1086
+ _files: Dict[
1087
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1088
+ ] = {}
1089
+ _body_params: Optional[bytes] = None
1090
+
1091
+ # process the path parameters
1092
+ if tenant_id is not None:
1093
+ _path_params['tenantId'] = tenant_id
1094
+ # process the query parameters
1095
+ # process the header parameters
1096
+ # process the form parameters
1097
+ # process the body parameter
1098
+
1099
+
1100
+ # set the HTTP header `Accept`
1101
+ if 'Accept' not in _header_params:
1102
+ _header_params['Accept'] = self.api_client.select_header_accept(
1103
+ [
1104
+ 'application/json'
1105
+ ]
1106
+ )
1107
+
1108
+
1109
+ # authentication setting
1110
+ _auth_settings: List[str] = [
1111
+ 'CookieAuth',
1112
+ 'ApiKeyAuth',
1113
+ 'OAuth2Auth',
1114
+ 'OAuth2Auth',
1115
+ 'BearerAuth'
1116
+ ]
1117
+
1118
+ return self.api_client.param_serialize(
1119
+ method='PUT',
1120
+ resource_path='/v1/admin/tenants/{tenantId}/disable',
1121
+ path_params=_path_params,
1122
+ query_params=_query_params,
1123
+ header_params=_header_params,
1124
+ body=_body_params,
1125
+ post_params=_form_params,
1126
+ files=_files,
1127
+ auth_settings=_auth_settings,
1128
+ collection_formats=_collection_formats,
1129
+ _host=_host,
1130
+ _request_auth=_request_auth
1131
+ )
1132
+
1133
+
1134
+
1135
+
1136
+ @validate_call
1137
+ def enable_tenant(
1138
+ self,
1139
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1140
+ _request_timeout: Union[
1141
+ None,
1142
+ Annotated[StrictFloat, Field(gt=0)],
1143
+ Tuple[
1144
+ Annotated[StrictFloat, Field(gt=0)],
1145
+ Annotated[StrictFloat, Field(gt=0)]
1146
+ ]
1147
+ ] = None,
1148
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1149
+ _content_type: Optional[StrictStr] = None,
1150
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1151
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1152
+ ) -> AdminTenantStatusAPIDTO:
1153
+ """Enable an analytic tenant
1154
+
1155
+ An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do.
1156
+
1157
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1158
+ :type tenant_id: str
1159
+ :param _request_timeout: timeout setting for this request. If one
1160
+ number provided, it will be total request
1161
+ timeout. It can also be a pair (tuple) of
1162
+ (connection, read) timeouts.
1163
+ :type _request_timeout: int, tuple(int, int), optional
1164
+ :param _request_auth: set to override the auth_settings for an a single
1165
+ request; this effectively ignores the
1166
+ authentication in the spec for a single request.
1167
+ :type _request_auth: dict, optional
1168
+ :param _content_type: force content-type for the request.
1169
+ :type _content_type: str, Optional
1170
+ :param _headers: set to override the headers for a single
1171
+ request; this effectively ignores the headers
1172
+ in the spec for a single request.
1173
+ :type _headers: dict, optional
1174
+ :param _host_index: set to override the host_index for a single
1175
+ request; this effectively ignores the host_index
1176
+ in the spec for a single request.
1177
+ :type _host_index: int, optional
1178
+ :return: Returns the result object.
1179
+ """ # noqa: E501
1180
+
1181
+ _param = self._enable_tenant_serialize(
1182
+ tenant_id=tenant_id,
1183
+ _request_auth=_request_auth,
1184
+ _content_type=_content_type,
1185
+ _headers=_headers,
1186
+ _host_index=_host_index
1187
+ )
1188
+
1189
+ _response_types_map: Dict[str, Optional[str]] = {
1190
+ '200': "AdminTenantStatusAPIDTO",
1191
+ }
1192
+ response_data = self.api_client.call_api(
1193
+ *_param,
1194
+ _request_timeout=_request_timeout
1195
+ )
1196
+ response_data.read()
1197
+ return self.api_client.response_deserialize(
1198
+ response_data=response_data,
1199
+ response_types_map=_response_types_map,
1200
+ ).data
1201
+
1202
+
1203
+ @validate_call
1204
+ def enable_tenant_with_http_info(
1205
+ self,
1206
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1207
+ _request_timeout: Union[
1208
+ None,
1209
+ Annotated[StrictFloat, Field(gt=0)],
1210
+ Tuple[
1211
+ Annotated[StrictFloat, Field(gt=0)],
1212
+ Annotated[StrictFloat, Field(gt=0)]
1213
+ ]
1214
+ ] = None,
1215
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1216
+ _content_type: Optional[StrictStr] = None,
1217
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1218
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1219
+ ) -> ApiResponse[AdminTenantStatusAPIDTO]:
1220
+ """Enable an analytic tenant
1221
+
1222
+ An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do.
1223
+
1224
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1225
+ :type tenant_id: str
1226
+ :param _request_timeout: timeout setting for this request. If one
1227
+ number provided, it will be total request
1228
+ timeout. It can also be a pair (tuple) of
1229
+ (connection, read) timeouts.
1230
+ :type _request_timeout: int, tuple(int, int), optional
1231
+ :param _request_auth: set to override the auth_settings for an a single
1232
+ request; this effectively ignores the
1233
+ authentication in the spec for a single request.
1234
+ :type _request_auth: dict, optional
1235
+ :param _content_type: force content-type for the request.
1236
+ :type _content_type: str, Optional
1237
+ :param _headers: set to override the headers for a single
1238
+ request; this effectively ignores the headers
1239
+ in the spec for a single request.
1240
+ :type _headers: dict, optional
1241
+ :param _host_index: set to override the host_index for a single
1242
+ request; this effectively ignores the host_index
1243
+ in the spec for a single request.
1244
+ :type _host_index: int, optional
1245
+ :return: Returns the result object.
1246
+ """ # noqa: E501
1247
+
1248
+ _param = self._enable_tenant_serialize(
1249
+ tenant_id=tenant_id,
1250
+ _request_auth=_request_auth,
1251
+ _content_type=_content_type,
1252
+ _headers=_headers,
1253
+ _host_index=_host_index
1254
+ )
1255
+
1256
+ _response_types_map: Dict[str, Optional[str]] = {
1257
+ '200': "AdminTenantStatusAPIDTO",
1258
+ }
1259
+ response_data = self.api_client.call_api(
1260
+ *_param,
1261
+ _request_timeout=_request_timeout
1262
+ )
1263
+ response_data.read()
1264
+ return self.api_client.response_deserialize(
1265
+ response_data=response_data,
1266
+ response_types_map=_response_types_map,
1267
+ )
1268
+
1269
+
1270
+ @validate_call
1271
+ def enable_tenant_without_preload_content(
1272
+ self,
1273
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1274
+ _request_timeout: Union[
1275
+ None,
1276
+ Annotated[StrictFloat, Field(gt=0)],
1277
+ Tuple[
1278
+ Annotated[StrictFloat, Field(gt=0)],
1279
+ Annotated[StrictFloat, Field(gt=0)]
1280
+ ]
1281
+ ] = None,
1282
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1283
+ _content_type: Optional[StrictStr] = None,
1284
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1285
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1286
+ ) -> RESTResponseType:
1287
+ """Enable an analytic tenant
1288
+
1289
+ An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do.
1290
+
1291
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1292
+ :type tenant_id: str
1293
+ :param _request_timeout: timeout setting for this request. If one
1294
+ number provided, it will be total request
1295
+ timeout. It can also be a pair (tuple) of
1296
+ (connection, read) timeouts.
1297
+ :type _request_timeout: int, tuple(int, int), optional
1298
+ :param _request_auth: set to override the auth_settings for an a single
1299
+ request; this effectively ignores the
1300
+ authentication in the spec for a single request.
1301
+ :type _request_auth: dict, optional
1302
+ :param _content_type: force content-type for the request.
1303
+ :type _content_type: str, Optional
1304
+ :param _headers: set to override the headers for a single
1305
+ request; this effectively ignores the headers
1306
+ in the spec for a single request.
1307
+ :type _headers: dict, optional
1308
+ :param _host_index: set to override the host_index for a single
1309
+ request; this effectively ignores the host_index
1310
+ in the spec for a single request.
1311
+ :type _host_index: int, optional
1312
+ :return: Returns the result object.
1313
+ """ # noqa: E501
1314
+
1315
+ _param = self._enable_tenant_serialize(
1316
+ tenant_id=tenant_id,
1317
+ _request_auth=_request_auth,
1318
+ _content_type=_content_type,
1319
+ _headers=_headers,
1320
+ _host_index=_host_index
1321
+ )
1322
+
1323
+ _response_types_map: Dict[str, Optional[str]] = {
1324
+ '200': "AdminTenantStatusAPIDTO",
1325
+ }
1326
+ response_data = self.api_client.call_api(
1327
+ *_param,
1328
+ _request_timeout=_request_timeout
1329
+ )
1330
+ return response_data.response
1331
+
1332
+
1333
+ def _enable_tenant_serialize(
1334
+ self,
1335
+ tenant_id,
1336
+ _request_auth,
1337
+ _content_type,
1338
+ _headers,
1339
+ _host_index,
1340
+ ) -> RequestSerialized:
1341
+
1342
+ _host = None
1343
+
1344
+ _collection_formats: Dict[str, str] = {
1345
+ }
1346
+
1347
+ _path_params: Dict[str, str] = {}
1348
+ _query_params: List[Tuple[str, str]] = []
1349
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1350
+ _form_params: List[Tuple[str, str]] = []
1351
+ _files: Dict[
1352
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1353
+ ] = {}
1354
+ _body_params: Optional[bytes] = None
1355
+
1356
+ # process the path parameters
1357
+ if tenant_id is not None:
1358
+ _path_params['tenantId'] = tenant_id
1359
+ # process the query parameters
1360
+ # process the header parameters
1361
+ # process the form parameters
1362
+ # process the body parameter
1363
+
1364
+
1365
+ # set the HTTP header `Accept`
1366
+ if 'Accept' not in _header_params:
1367
+ _header_params['Accept'] = self.api_client.select_header_accept(
1368
+ [
1369
+ 'application/json'
1370
+ ]
1371
+ )
1372
+
1373
+
1374
+ # authentication setting
1375
+ _auth_settings: List[str] = [
1376
+ 'CookieAuth',
1377
+ 'ApiKeyAuth',
1378
+ 'OAuth2Auth',
1379
+ 'OAuth2Auth',
1380
+ 'BearerAuth'
1381
+ ]
1382
+
1383
+ return self.api_client.param_serialize(
1384
+ method='PUT',
1385
+ resource_path='/v1/admin/tenants/{tenantId}/enable',
1386
+ path_params=_path_params,
1387
+ query_params=_query_params,
1388
+ header_params=_header_params,
1389
+ body=_body_params,
1390
+ post_params=_form_params,
1391
+ files=_files,
1392
+ auth_settings=_auth_settings,
1393
+ collection_formats=_collection_formats,
1394
+ _host=_host,
1395
+ _request_auth=_request_auth
1396
+ )
1397
+
1398
+
1399
+
1400
+
1401
+ @validate_call
1402
+ def get_tenant(
1403
+ self,
1404
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1405
+ _request_timeout: Union[
1406
+ None,
1407
+ Annotated[StrictFloat, Field(gt=0)],
1408
+ Tuple[
1409
+ Annotated[StrictFloat, Field(gt=0)],
1410
+ Annotated[StrictFloat, Field(gt=0)]
1411
+ ]
1412
+ ] = None,
1413
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1414
+ _content_type: Optional[StrictStr] = None,
1415
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1416
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1417
+ ) -> AdminTenantDetailAPIDTO:
1418
+ """Retrieve an analytic tenant's details
1419
+
1420
+ Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant.
1421
+
1422
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1423
+ :type tenant_id: str
1424
+ :param _request_timeout: timeout setting for this request. If one
1425
+ number provided, it will be total request
1426
+ timeout. It can also be a pair (tuple) of
1427
+ (connection, read) timeouts.
1428
+ :type _request_timeout: int, tuple(int, int), optional
1429
+ :param _request_auth: set to override the auth_settings for an a single
1430
+ request; this effectively ignores the
1431
+ authentication in the spec for a single request.
1432
+ :type _request_auth: dict, optional
1433
+ :param _content_type: force content-type for the request.
1434
+ :type _content_type: str, Optional
1435
+ :param _headers: set to override the headers for a single
1436
+ request; this effectively ignores the headers
1437
+ in the spec for a single request.
1438
+ :type _headers: dict, optional
1439
+ :param _host_index: set to override the host_index for a single
1440
+ request; this effectively ignores the host_index
1441
+ in the spec for a single request.
1442
+ :type _host_index: int, optional
1443
+ :return: Returns the result object.
1444
+ """ # noqa: E501
1445
+
1446
+ _param = self._get_tenant_serialize(
1447
+ tenant_id=tenant_id,
1448
+ _request_auth=_request_auth,
1449
+ _content_type=_content_type,
1450
+ _headers=_headers,
1451
+ _host_index=_host_index
1452
+ )
1453
+
1454
+ _response_types_map: Dict[str, Optional[str]] = {
1455
+ '200': "AdminTenantDetailAPIDTO",
1456
+ }
1457
+ response_data = self.api_client.call_api(
1458
+ *_param,
1459
+ _request_timeout=_request_timeout
1460
+ )
1461
+ response_data.read()
1462
+ return self.api_client.response_deserialize(
1463
+ response_data=response_data,
1464
+ response_types_map=_response_types_map,
1465
+ ).data
1466
+
1467
+
1468
+ @validate_call
1469
+ def get_tenant_with_http_info(
1470
+ self,
1471
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1472
+ _request_timeout: Union[
1473
+ None,
1474
+ Annotated[StrictFloat, Field(gt=0)],
1475
+ Tuple[
1476
+ Annotated[StrictFloat, Field(gt=0)],
1477
+ Annotated[StrictFloat, Field(gt=0)]
1478
+ ]
1479
+ ] = None,
1480
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1481
+ _content_type: Optional[StrictStr] = None,
1482
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1483
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1484
+ ) -> ApiResponse[AdminTenantDetailAPIDTO]:
1485
+ """Retrieve an analytic tenant's details
1486
+
1487
+ Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant.
1488
+
1489
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1490
+ :type tenant_id: str
1491
+ :param _request_timeout: timeout setting for this request. If one
1492
+ number provided, it will be total request
1493
+ timeout. It can also be a pair (tuple) of
1494
+ (connection, read) timeouts.
1495
+ :type _request_timeout: int, tuple(int, int), optional
1496
+ :param _request_auth: set to override the auth_settings for an a single
1497
+ request; this effectively ignores the
1498
+ authentication in the spec for a single request.
1499
+ :type _request_auth: dict, optional
1500
+ :param _content_type: force content-type for the request.
1501
+ :type _content_type: str, Optional
1502
+ :param _headers: set to override the headers for a single
1503
+ request; this effectively ignores the headers
1504
+ in the spec for a single request.
1505
+ :type _headers: dict, optional
1506
+ :param _host_index: set to override the host_index for a single
1507
+ request; this effectively ignores the host_index
1508
+ in the spec for a single request.
1509
+ :type _host_index: int, optional
1510
+ :return: Returns the result object.
1511
+ """ # noqa: E501
1512
+
1513
+ _param = self._get_tenant_serialize(
1514
+ tenant_id=tenant_id,
1515
+ _request_auth=_request_auth,
1516
+ _content_type=_content_type,
1517
+ _headers=_headers,
1518
+ _host_index=_host_index
1519
+ )
1520
+
1521
+ _response_types_map: Dict[str, Optional[str]] = {
1522
+ '200': "AdminTenantDetailAPIDTO",
1523
+ }
1524
+ response_data = self.api_client.call_api(
1525
+ *_param,
1526
+ _request_timeout=_request_timeout
1527
+ )
1528
+ response_data.read()
1529
+ return self.api_client.response_deserialize(
1530
+ response_data=response_data,
1531
+ response_types_map=_response_types_map,
1532
+ )
1533
+
1534
+
1535
+ @validate_call
1536
+ def get_tenant_without_preload_content(
1537
+ self,
1538
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
1539
+ _request_timeout: Union[
1540
+ None,
1541
+ Annotated[StrictFloat, Field(gt=0)],
1542
+ Tuple[
1543
+ Annotated[StrictFloat, Field(gt=0)],
1544
+ Annotated[StrictFloat, Field(gt=0)]
1545
+ ]
1546
+ ] = None,
1547
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1548
+ _content_type: Optional[StrictStr] = None,
1549
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1550
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1551
+ ) -> RESTResponseType:
1552
+ """Retrieve an analytic tenant's details
1553
+
1554
+ Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant.
1555
+
1556
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
1557
+ :type tenant_id: str
1558
+ :param _request_timeout: timeout setting for this request. If one
1559
+ number provided, it will be total request
1560
+ timeout. It can also be a pair (tuple) of
1561
+ (connection, read) timeouts.
1562
+ :type _request_timeout: int, tuple(int, int), optional
1563
+ :param _request_auth: set to override the auth_settings for an a single
1564
+ request; this effectively ignores the
1565
+ authentication in the spec for a single request.
1566
+ :type _request_auth: dict, optional
1567
+ :param _content_type: force content-type for the request.
1568
+ :type _content_type: str, Optional
1569
+ :param _headers: set to override the headers for a single
1570
+ request; this effectively ignores the headers
1571
+ in the spec for a single request.
1572
+ :type _headers: dict, optional
1573
+ :param _host_index: set to override the host_index for a single
1574
+ request; this effectively ignores the host_index
1575
+ in the spec for a single request.
1576
+ :type _host_index: int, optional
1577
+ :return: Returns the result object.
1578
+ """ # noqa: E501
1579
+
1580
+ _param = self._get_tenant_serialize(
1581
+ tenant_id=tenant_id,
1582
+ _request_auth=_request_auth,
1583
+ _content_type=_content_type,
1584
+ _headers=_headers,
1585
+ _host_index=_host_index
1586
+ )
1587
+
1588
+ _response_types_map: Dict[str, Optional[str]] = {
1589
+ '200': "AdminTenantDetailAPIDTO",
1590
+ }
1591
+ response_data = self.api_client.call_api(
1592
+ *_param,
1593
+ _request_timeout=_request_timeout
1594
+ )
1595
+ return response_data.response
1596
+
1597
+
1598
+ def _get_tenant_serialize(
1599
+ self,
1600
+ tenant_id,
1601
+ _request_auth,
1602
+ _content_type,
1603
+ _headers,
1604
+ _host_index,
1605
+ ) -> RequestSerialized:
1606
+
1607
+ _host = None
1608
+
1609
+ _collection_formats: Dict[str, str] = {
1610
+ }
1611
+
1612
+ _path_params: Dict[str, str] = {}
1613
+ _query_params: List[Tuple[str, str]] = []
1614
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1615
+ _form_params: List[Tuple[str, str]] = []
1616
+ _files: Dict[
1617
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1618
+ ] = {}
1619
+ _body_params: Optional[bytes] = None
1620
+
1621
+ # process the path parameters
1622
+ if tenant_id is not None:
1623
+ _path_params['tenantId'] = tenant_id
1624
+ # process the query parameters
1625
+ # process the header parameters
1626
+ # process the form parameters
1627
+ # process the body parameter
1628
+
1629
+
1630
+ # set the HTTP header `Accept`
1631
+ if 'Accept' not in _header_params:
1632
+ _header_params['Accept'] = self.api_client.select_header_accept(
1633
+ [
1634
+ 'application/json'
1635
+ ]
1636
+ )
1637
+
1638
+
1639
+ # authentication setting
1640
+ _auth_settings: List[str] = [
1641
+ 'CookieAuth',
1642
+ 'ApiKeyAuth',
1643
+ 'OAuth2Auth',
1644
+ 'OAuth2Auth',
1645
+ 'BearerAuth'
1646
+ ]
1647
+
1648
+ return self.api_client.param_serialize(
1649
+ method='GET',
1650
+ resource_path='/v1/admin/tenants/{tenantId}',
1651
+ path_params=_path_params,
1652
+ query_params=_query_params,
1653
+ header_params=_header_params,
1654
+ body=_body_params,
1655
+ post_params=_form_params,
1656
+ files=_files,
1657
+ auth_settings=_auth_settings,
1658
+ collection_formats=_collection_formats,
1659
+ _host=_host,
1660
+ _request_auth=_request_auth
1661
+ )
1662
+
1663
+
1664
+
1665
+
1666
+ @validate_call
1667
+ def get_tenants(
1668
+ self,
1669
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
1670
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
1671
+ details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None,
1672
+ _request_timeout: Union[
1673
+ None,
1674
+ Annotated[StrictFloat, Field(gt=0)],
1675
+ Tuple[
1676
+ Annotated[StrictFloat, Field(gt=0)],
1677
+ Annotated[StrictFloat, Field(gt=0)]
1678
+ ]
1679
+ ] = None,
1680
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1681
+ _content_type: Optional[StrictStr] = None,
1682
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1683
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1684
+ ) -> AdminAllTenantsStatusAPIDTO:
1685
+ """Retrieve a list of all analytic tenants
1686
+
1687
+ Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested.
1688
+
1689
+ :param limit: The limit of analytic tenant details to retrieve.
1690
+ :type limit: int
1691
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
1692
+ :type start: int
1693
+ :param details: If `true`, the response returns information about the data version and modules.
1694
+ :type details: bool
1695
+ :param _request_timeout: timeout setting for this request. If one
1696
+ number provided, it will be total request
1697
+ timeout. It can also be a pair (tuple) of
1698
+ (connection, read) timeouts.
1699
+ :type _request_timeout: int, tuple(int, int), optional
1700
+ :param _request_auth: set to override the auth_settings for an a single
1701
+ request; this effectively ignores the
1702
+ authentication in the spec for a single request.
1703
+ :type _request_auth: dict, optional
1704
+ :param _content_type: force content-type for the request.
1705
+ :type _content_type: str, Optional
1706
+ :param _headers: set to override the headers for a single
1707
+ request; this effectively ignores the headers
1708
+ in the spec for a single request.
1709
+ :type _headers: dict, optional
1710
+ :param _host_index: set to override the host_index for a single
1711
+ request; this effectively ignores the host_index
1712
+ in the spec for a single request.
1713
+ :type _host_index: int, optional
1714
+ :return: Returns the result object.
1715
+ """ # noqa: E501
1716
+
1717
+ _param = self._get_tenants_serialize(
1718
+ limit=limit,
1719
+ start=start,
1720
+ details=details,
1721
+ _request_auth=_request_auth,
1722
+ _content_type=_content_type,
1723
+ _headers=_headers,
1724
+ _host_index=_host_index
1725
+ )
1726
+
1727
+ _response_types_map: Dict[str, Optional[str]] = {
1728
+ '200': "AdminAllTenantsStatusAPIDTO",
1729
+ }
1730
+ response_data = self.api_client.call_api(
1731
+ *_param,
1732
+ _request_timeout=_request_timeout
1733
+ )
1734
+ response_data.read()
1735
+ return self.api_client.response_deserialize(
1736
+ response_data=response_data,
1737
+ response_types_map=_response_types_map,
1738
+ ).data
1739
+
1740
+
1741
+ @validate_call
1742
+ def get_tenants_with_http_info(
1743
+ self,
1744
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
1745
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
1746
+ details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None,
1747
+ _request_timeout: Union[
1748
+ None,
1749
+ Annotated[StrictFloat, Field(gt=0)],
1750
+ Tuple[
1751
+ Annotated[StrictFloat, Field(gt=0)],
1752
+ Annotated[StrictFloat, Field(gt=0)]
1753
+ ]
1754
+ ] = None,
1755
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1756
+ _content_type: Optional[StrictStr] = None,
1757
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1758
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1759
+ ) -> ApiResponse[AdminAllTenantsStatusAPIDTO]:
1760
+ """Retrieve a list of all analytic tenants
1761
+
1762
+ Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested.
1763
+
1764
+ :param limit: The limit of analytic tenant details to retrieve.
1765
+ :type limit: int
1766
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
1767
+ :type start: int
1768
+ :param details: If `true`, the response returns information about the data version and modules.
1769
+ :type details: bool
1770
+ :param _request_timeout: timeout setting for this request. If one
1771
+ number provided, it will be total request
1772
+ timeout. It can also be a pair (tuple) of
1773
+ (connection, read) timeouts.
1774
+ :type _request_timeout: int, tuple(int, int), optional
1775
+ :param _request_auth: set to override the auth_settings for an a single
1776
+ request; this effectively ignores the
1777
+ authentication in the spec for a single request.
1778
+ :type _request_auth: dict, optional
1779
+ :param _content_type: force content-type for the request.
1780
+ :type _content_type: str, Optional
1781
+ :param _headers: set to override the headers for a single
1782
+ request; this effectively ignores the headers
1783
+ in the spec for a single request.
1784
+ :type _headers: dict, optional
1785
+ :param _host_index: set to override the host_index for a single
1786
+ request; this effectively ignores the host_index
1787
+ in the spec for a single request.
1788
+ :type _host_index: int, optional
1789
+ :return: Returns the result object.
1790
+ """ # noqa: E501
1791
+
1792
+ _param = self._get_tenants_serialize(
1793
+ limit=limit,
1794
+ start=start,
1795
+ details=details,
1796
+ _request_auth=_request_auth,
1797
+ _content_type=_content_type,
1798
+ _headers=_headers,
1799
+ _host_index=_host_index
1800
+ )
1801
+
1802
+ _response_types_map: Dict[str, Optional[str]] = {
1803
+ '200': "AdminAllTenantsStatusAPIDTO",
1804
+ }
1805
+ response_data = self.api_client.call_api(
1806
+ *_param,
1807
+ _request_timeout=_request_timeout
1808
+ )
1809
+ response_data.read()
1810
+ return self.api_client.response_deserialize(
1811
+ response_data=response_data,
1812
+ response_types_map=_response_types_map,
1813
+ )
1814
+
1815
+
1816
+ @validate_call
1817
+ def get_tenants_without_preload_content(
1818
+ self,
1819
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
1820
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
1821
+ details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None,
1822
+ _request_timeout: Union[
1823
+ None,
1824
+ Annotated[StrictFloat, Field(gt=0)],
1825
+ Tuple[
1826
+ Annotated[StrictFloat, Field(gt=0)],
1827
+ Annotated[StrictFloat, Field(gt=0)]
1828
+ ]
1829
+ ] = None,
1830
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1831
+ _content_type: Optional[StrictStr] = None,
1832
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1833
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1834
+ ) -> RESTResponseType:
1835
+ """Retrieve a list of all analytic tenants
1836
+
1837
+ Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested.
1838
+
1839
+ :param limit: The limit of analytic tenant details to retrieve.
1840
+ :type limit: int
1841
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
1842
+ :type start: int
1843
+ :param details: If `true`, the response returns information about the data version and modules.
1844
+ :type details: bool
1845
+ :param _request_timeout: timeout setting for this request. If one
1846
+ number provided, it will be total request
1847
+ timeout. It can also be a pair (tuple) of
1848
+ (connection, read) timeouts.
1849
+ :type _request_timeout: int, tuple(int, int), optional
1850
+ :param _request_auth: set to override the auth_settings for an a single
1851
+ request; this effectively ignores the
1852
+ authentication in the spec for a single request.
1853
+ :type _request_auth: dict, optional
1854
+ :param _content_type: force content-type for the request.
1855
+ :type _content_type: str, Optional
1856
+ :param _headers: set to override the headers for a single
1857
+ request; this effectively ignores the headers
1858
+ in the spec for a single request.
1859
+ :type _headers: dict, optional
1860
+ :param _host_index: set to override the host_index for a single
1861
+ request; this effectively ignores the host_index
1862
+ in the spec for a single request.
1863
+ :type _host_index: int, optional
1864
+ :return: Returns the result object.
1865
+ """ # noqa: E501
1866
+
1867
+ _param = self._get_tenants_serialize(
1868
+ limit=limit,
1869
+ start=start,
1870
+ details=details,
1871
+ _request_auth=_request_auth,
1872
+ _content_type=_content_type,
1873
+ _headers=_headers,
1874
+ _host_index=_host_index
1875
+ )
1876
+
1877
+ _response_types_map: Dict[str, Optional[str]] = {
1878
+ '200': "AdminAllTenantsStatusAPIDTO",
1879
+ }
1880
+ response_data = self.api_client.call_api(
1881
+ *_param,
1882
+ _request_timeout=_request_timeout
1883
+ )
1884
+ return response_data.response
1885
+
1886
+
1887
+ def _get_tenants_serialize(
1888
+ self,
1889
+ limit,
1890
+ start,
1891
+ details,
1892
+ _request_auth,
1893
+ _content_type,
1894
+ _headers,
1895
+ _host_index,
1896
+ ) -> RequestSerialized:
1897
+
1898
+ _host = None
1899
+
1900
+ _collection_formats: Dict[str, str] = {
1901
+ }
1902
+
1903
+ _path_params: Dict[str, str] = {}
1904
+ _query_params: List[Tuple[str, str]] = []
1905
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1906
+ _form_params: List[Tuple[str, str]] = []
1907
+ _files: Dict[
1908
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1909
+ ] = {}
1910
+ _body_params: Optional[bytes] = None
1911
+
1912
+ # process the path parameters
1913
+ # process the query parameters
1914
+ if limit is not None:
1915
+
1916
+ _query_params.append(('limit', limit))
1917
+
1918
+ if start is not None:
1919
+
1920
+ _query_params.append(('start', start))
1921
+
1922
+ if details is not None:
1923
+
1924
+ _query_params.append(('details', details))
1925
+
1926
+ # process the header parameters
1927
+ # process the form parameters
1928
+ # process the body parameter
1929
+
1930
+
1931
+ # set the HTTP header `Accept`
1932
+ if 'Accept' not in _header_params:
1933
+ _header_params['Accept'] = self.api_client.select_header_accept(
1934
+ [
1935
+ 'application/json'
1936
+ ]
1937
+ )
1938
+
1939
+
1940
+ # authentication setting
1941
+ _auth_settings: List[str] = [
1942
+ 'CookieAuth',
1943
+ 'ApiKeyAuth',
1944
+ 'OAuth2Auth',
1945
+ 'OAuth2Auth',
1946
+ 'BearerAuth'
1947
+ ]
1948
+
1949
+ return self.api_client.param_serialize(
1950
+ method='GET',
1951
+ resource_path='/v1/admin/tenants',
1952
+ path_params=_path_params,
1953
+ query_params=_query_params,
1954
+ header_params=_header_params,
1955
+ body=_body_params,
1956
+ post_params=_form_params,
1957
+ files=_files,
1958
+ auth_settings=_auth_settings,
1959
+ collection_formats=_collection_formats,
1960
+ _host=_host,
1961
+ _request_auth=_request_auth
1962
+ )
1963
+
1964
+
1965
+
1966
+
1967
+ @validate_call
1968
+ def update_tenant(
1969
+ self,
1970
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")],
1971
+ admin_update_tenant_model: AdminUpdateTenantModel,
1972
+ _request_timeout: Union[
1973
+ None,
1974
+ Annotated[StrictFloat, Field(gt=0)],
1975
+ Tuple[
1976
+ Annotated[StrictFloat, Field(gt=0)],
1977
+ Annotated[StrictFloat, Field(gt=0)]
1978
+ ]
1979
+ ] = None,
1980
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1981
+ _content_type: Optional[StrictStr] = None,
1982
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1983
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1984
+ ) -> AdminTenantProvisionAPIDTO:
1985
+ """Update an analytic tenant
1986
+
1987
+ You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`.
1988
+
1989
+ :param tenant_id: The ID of the tenant to update. (required)
1990
+ :type tenant_id: str
1991
+ :param admin_update_tenant_model: (required)
1992
+ :type admin_update_tenant_model: AdminUpdateTenantModel
1993
+ :param _request_timeout: timeout setting for this request. If one
1994
+ number provided, it will be total request
1995
+ timeout. It can also be a pair (tuple) of
1996
+ (connection, read) timeouts.
1997
+ :type _request_timeout: int, tuple(int, int), optional
1998
+ :param _request_auth: set to override the auth_settings for an a single
1999
+ request; this effectively ignores the
2000
+ authentication in the spec for a single request.
2001
+ :type _request_auth: dict, optional
2002
+ :param _content_type: force content-type for the request.
2003
+ :type _content_type: str, Optional
2004
+ :param _headers: set to override the headers for a single
2005
+ request; this effectively ignores the headers
2006
+ in the spec for a single request.
2007
+ :type _headers: dict, optional
2008
+ :param _host_index: set to override the host_index for a single
2009
+ request; this effectively ignores the host_index
2010
+ in the spec for a single request.
2011
+ :type _host_index: int, optional
2012
+ :return: Returns the result object.
2013
+ """ # noqa: E501
2014
+
2015
+ _param = self._update_tenant_serialize(
2016
+ tenant_id=tenant_id,
2017
+ admin_update_tenant_model=admin_update_tenant_model,
2018
+ _request_auth=_request_auth,
2019
+ _content_type=_content_type,
2020
+ _headers=_headers,
2021
+ _host_index=_host_index
2022
+ )
2023
+
2024
+ _response_types_map: Dict[str, Optional[str]] = {
2025
+ '200': "AdminTenantProvisionAPIDTO",
2026
+ }
2027
+ response_data = self.api_client.call_api(
2028
+ *_param,
2029
+ _request_timeout=_request_timeout
2030
+ )
2031
+ response_data.read()
2032
+ return self.api_client.response_deserialize(
2033
+ response_data=response_data,
2034
+ response_types_map=_response_types_map,
2035
+ ).data
2036
+
2037
+
2038
+ @validate_call
2039
+ def update_tenant_with_http_info(
2040
+ self,
2041
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")],
2042
+ admin_update_tenant_model: AdminUpdateTenantModel,
2043
+ _request_timeout: Union[
2044
+ None,
2045
+ Annotated[StrictFloat, Field(gt=0)],
2046
+ Tuple[
2047
+ Annotated[StrictFloat, Field(gt=0)],
2048
+ Annotated[StrictFloat, Field(gt=0)]
2049
+ ]
2050
+ ] = None,
2051
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2052
+ _content_type: Optional[StrictStr] = None,
2053
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2054
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2055
+ ) -> ApiResponse[AdminTenantProvisionAPIDTO]:
2056
+ """Update an analytic tenant
2057
+
2058
+ You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`.
2059
+
2060
+ :param tenant_id: The ID of the tenant to update. (required)
2061
+ :type tenant_id: str
2062
+ :param admin_update_tenant_model: (required)
2063
+ :type admin_update_tenant_model: AdminUpdateTenantModel
2064
+ :param _request_timeout: timeout setting for this request. If one
2065
+ number provided, it will be total request
2066
+ timeout. It can also be a pair (tuple) of
2067
+ (connection, read) timeouts.
2068
+ :type _request_timeout: int, tuple(int, int), optional
2069
+ :param _request_auth: set to override the auth_settings for an a single
2070
+ request; this effectively ignores the
2071
+ authentication in the spec for a single request.
2072
+ :type _request_auth: dict, optional
2073
+ :param _content_type: force content-type for the request.
2074
+ :type _content_type: str, Optional
2075
+ :param _headers: set to override the headers for a single
2076
+ request; this effectively ignores the headers
2077
+ in the spec for a single request.
2078
+ :type _headers: dict, optional
2079
+ :param _host_index: set to override the host_index for a single
2080
+ request; this effectively ignores the host_index
2081
+ in the spec for a single request.
2082
+ :type _host_index: int, optional
2083
+ :return: Returns the result object.
2084
+ """ # noqa: E501
2085
+
2086
+ _param = self._update_tenant_serialize(
2087
+ tenant_id=tenant_id,
2088
+ admin_update_tenant_model=admin_update_tenant_model,
2089
+ _request_auth=_request_auth,
2090
+ _content_type=_content_type,
2091
+ _headers=_headers,
2092
+ _host_index=_host_index
2093
+ )
2094
+
2095
+ _response_types_map: Dict[str, Optional[str]] = {
2096
+ '200': "AdminTenantProvisionAPIDTO",
2097
+ }
2098
+ response_data = self.api_client.call_api(
2099
+ *_param,
2100
+ _request_timeout=_request_timeout
2101
+ )
2102
+ response_data.read()
2103
+ return self.api_client.response_deserialize(
2104
+ response_data=response_data,
2105
+ response_types_map=_response_types_map,
2106
+ )
2107
+
2108
+
2109
+ @validate_call
2110
+ def update_tenant_without_preload_content(
2111
+ self,
2112
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")],
2113
+ admin_update_tenant_model: AdminUpdateTenantModel,
2114
+ _request_timeout: Union[
2115
+ None,
2116
+ Annotated[StrictFloat, Field(gt=0)],
2117
+ Tuple[
2118
+ Annotated[StrictFloat, Field(gt=0)],
2119
+ Annotated[StrictFloat, Field(gt=0)]
2120
+ ]
2121
+ ] = None,
2122
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2123
+ _content_type: Optional[StrictStr] = None,
2124
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2125
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2126
+ ) -> RESTResponseType:
2127
+ """Update an analytic tenant
2128
+
2129
+ You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`.
2130
+
2131
+ :param tenant_id: The ID of the tenant to update. (required)
2132
+ :type tenant_id: str
2133
+ :param admin_update_tenant_model: (required)
2134
+ :type admin_update_tenant_model: AdminUpdateTenantModel
2135
+ :param _request_timeout: timeout setting for this request. If one
2136
+ number provided, it will be total request
2137
+ timeout. It can also be a pair (tuple) of
2138
+ (connection, read) timeouts.
2139
+ :type _request_timeout: int, tuple(int, int), optional
2140
+ :param _request_auth: set to override the auth_settings for an a single
2141
+ request; this effectively ignores the
2142
+ authentication in the spec for a single request.
2143
+ :type _request_auth: dict, optional
2144
+ :param _content_type: force content-type for the request.
2145
+ :type _content_type: str, Optional
2146
+ :param _headers: set to override the headers for a single
2147
+ request; this effectively ignores the headers
2148
+ in the spec for a single request.
2149
+ :type _headers: dict, optional
2150
+ :param _host_index: set to override the host_index for a single
2151
+ request; this effectively ignores the host_index
2152
+ in the spec for a single request.
2153
+ :type _host_index: int, optional
2154
+ :return: Returns the result object.
2155
+ """ # noqa: E501
2156
+
2157
+ _param = self._update_tenant_serialize(
2158
+ tenant_id=tenant_id,
2159
+ admin_update_tenant_model=admin_update_tenant_model,
2160
+ _request_auth=_request_auth,
2161
+ _content_type=_content_type,
2162
+ _headers=_headers,
2163
+ _host_index=_host_index
2164
+ )
2165
+
2166
+ _response_types_map: Dict[str, Optional[str]] = {
2167
+ '200': "AdminTenantProvisionAPIDTO",
2168
+ }
2169
+ response_data = self.api_client.call_api(
2170
+ *_param,
2171
+ _request_timeout=_request_timeout
2172
+ )
2173
+ return response_data.response
2174
+
2175
+
2176
+ def _update_tenant_serialize(
2177
+ self,
2178
+ tenant_id,
2179
+ admin_update_tenant_model,
2180
+ _request_auth,
2181
+ _content_type,
2182
+ _headers,
2183
+ _host_index,
2184
+ ) -> RequestSerialized:
2185
+
2186
+ _host = None
2187
+
2188
+ _collection_formats: Dict[str, str] = {
2189
+ }
2190
+
2191
+ _path_params: Dict[str, str] = {}
2192
+ _query_params: List[Tuple[str, str]] = []
2193
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2194
+ _form_params: List[Tuple[str, str]] = []
2195
+ _files: Dict[
2196
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2197
+ ] = {}
2198
+ _body_params: Optional[bytes] = None
2199
+
2200
+ # process the path parameters
2201
+ if tenant_id is not None:
2202
+ _path_params['tenantId'] = tenant_id
2203
+ # process the query parameters
2204
+ # process the header parameters
2205
+ # process the form parameters
2206
+ # process the body parameter
2207
+ if admin_update_tenant_model is not None:
2208
+ _body_params = admin_update_tenant_model
2209
+
2210
+
2211
+ # set the HTTP header `Accept`
2212
+ if 'Accept' not in _header_params:
2213
+ _header_params['Accept'] = self.api_client.select_header_accept(
2214
+ [
2215
+ 'application/json'
2216
+ ]
2217
+ )
2218
+
2219
+ # set the HTTP header `Content-Type`
2220
+ if _content_type:
2221
+ _header_params['Content-Type'] = _content_type
2222
+ else:
2223
+ _default_content_type = (
2224
+ self.api_client.select_header_content_type(
2225
+ [
2226
+ 'application/json'
2227
+ ]
2228
+ )
2229
+ )
2230
+ if _default_content_type is not None:
2231
+ _header_params['Content-Type'] = _default_content_type
2232
+
2233
+ # authentication setting
2234
+ _auth_settings: List[str] = [
2235
+ 'CookieAuth',
2236
+ 'ApiKeyAuth',
2237
+ 'OAuth2Auth',
2238
+ 'OAuth2Auth',
2239
+ 'BearerAuth'
2240
+ ]
2241
+
2242
+ return self.api_client.param_serialize(
2243
+ method='PUT',
2244
+ resource_path='/v1/admin/tenants/{tenantId}',
2245
+ path_params=_path_params,
2246
+ query_params=_query_params,
2247
+ header_params=_header_params,
2248
+ body=_body_params,
2249
+ post_params=_form_params,
2250
+ files=_files,
2251
+ auth_settings=_auth_settings,
2252
+ collection_formats=_collection_formats,
2253
+ _host=_host,
2254
+ _request_auth=_request_auth
2255
+ )
2256
+
2257
+
2258
+
2259
+
2260
+ @validate_call
2261
+ def validate_tenant(
2262
+ self,
2263
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
2264
+ 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,
2265
+ _request_timeout: Union[
2266
+ None,
2267
+ Annotated[StrictFloat, Field(gt=0)],
2268
+ Tuple[
2269
+ Annotated[StrictFloat, Field(gt=0)],
2270
+ Annotated[StrictFloat, Field(gt=0)]
2271
+ ]
2272
+ ] = None,
2273
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2274
+ _content_type: Optional[StrictStr] = None,
2275
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2276
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2277
+ ) -> DpAutomationTenantPreviewEntriesSummaryDTO:
2278
+ """Validate an analytic tenant's metric values
2279
+
2280
+ Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2281
+
2282
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
2283
+ :type tenant_id: str
2284
+ :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.
2285
+ :type target_tenant_id: str
2286
+ :param _request_timeout: timeout setting for this request. If one
2287
+ number provided, it will be total request
2288
+ timeout. It can also be a pair (tuple) of
2289
+ (connection, read) timeouts.
2290
+ :type _request_timeout: int, tuple(int, int), optional
2291
+ :param _request_auth: set to override the auth_settings for an a single
2292
+ request; this effectively ignores the
2293
+ authentication in the spec for a single request.
2294
+ :type _request_auth: dict, optional
2295
+ :param _content_type: force content-type for the request.
2296
+ :type _content_type: str, Optional
2297
+ :param _headers: set to override the headers for a single
2298
+ request; this effectively ignores the headers
2299
+ in the spec for a single request.
2300
+ :type _headers: dict, optional
2301
+ :param _host_index: set to override the host_index for a single
2302
+ request; this effectively ignores the host_index
2303
+ in the spec for a single request.
2304
+ :type _host_index: int, optional
2305
+ :return: Returns the result object.
2306
+ """ # noqa: E501
2307
+
2308
+ _param = self._validate_tenant_serialize(
2309
+ tenant_id=tenant_id,
2310
+ target_tenant_id=target_tenant_id,
2311
+ _request_auth=_request_auth,
2312
+ _content_type=_content_type,
2313
+ _headers=_headers,
2314
+ _host_index=_host_index
2315
+ )
2316
+
2317
+ _response_types_map: Dict[str, Optional[str]] = {
2318
+ '200': "DpAutomationTenantPreviewEntriesSummaryDTO",
2319
+ }
2320
+ response_data = self.api_client.call_api(
2321
+ *_param,
2322
+ _request_timeout=_request_timeout
2323
+ )
2324
+ response_data.read()
2325
+ return self.api_client.response_deserialize(
2326
+ response_data=response_data,
2327
+ response_types_map=_response_types_map,
2328
+ ).data
2329
+
2330
+
2331
+ @validate_call
2332
+ def validate_tenant_with_http_info(
2333
+ self,
2334
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
2335
+ 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,
2336
+ _request_timeout: Union[
2337
+ None,
2338
+ Annotated[StrictFloat, Field(gt=0)],
2339
+ Tuple[
2340
+ Annotated[StrictFloat, Field(gt=0)],
2341
+ Annotated[StrictFloat, Field(gt=0)]
2342
+ ]
2343
+ ] = None,
2344
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2345
+ _content_type: Optional[StrictStr] = None,
2346
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2347
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2348
+ ) -> ApiResponse[DpAutomationTenantPreviewEntriesSummaryDTO]:
2349
+ """Validate an analytic tenant's metric values
2350
+
2351
+ Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2352
+
2353
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
2354
+ :type tenant_id: str
2355
+ :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.
2356
+ :type target_tenant_id: str
2357
+ :param _request_timeout: timeout setting for this request. If one
2358
+ number provided, it will be total request
2359
+ timeout. It can also be a pair (tuple) of
2360
+ (connection, read) timeouts.
2361
+ :type _request_timeout: int, tuple(int, int), optional
2362
+ :param _request_auth: set to override the auth_settings for an a single
2363
+ request; this effectively ignores the
2364
+ authentication in the spec for a single request.
2365
+ :type _request_auth: dict, optional
2366
+ :param _content_type: force content-type for the request.
2367
+ :type _content_type: str, Optional
2368
+ :param _headers: set to override the headers for a single
2369
+ request; this effectively ignores the headers
2370
+ in the spec for a single request.
2371
+ :type _headers: dict, optional
2372
+ :param _host_index: set to override the host_index for a single
2373
+ request; this effectively ignores the host_index
2374
+ in the spec for a single request.
2375
+ :type _host_index: int, optional
2376
+ :return: Returns the result object.
2377
+ """ # noqa: E501
2378
+
2379
+ _param = self._validate_tenant_serialize(
2380
+ tenant_id=tenant_id,
2381
+ target_tenant_id=target_tenant_id,
2382
+ _request_auth=_request_auth,
2383
+ _content_type=_content_type,
2384
+ _headers=_headers,
2385
+ _host_index=_host_index
2386
+ )
2387
+
2388
+ _response_types_map: Dict[str, Optional[str]] = {
2389
+ '200': "DpAutomationTenantPreviewEntriesSummaryDTO",
2390
+ }
2391
+ response_data = self.api_client.call_api(
2392
+ *_param,
2393
+ _request_timeout=_request_timeout
2394
+ )
2395
+ response_data.read()
2396
+ return self.api_client.response_deserialize(
2397
+ response_data=response_data,
2398
+ response_types_map=_response_types_map,
2399
+ )
2400
+
2401
+
2402
+ @validate_call
2403
+ def validate_tenant_without_preload_content(
2404
+ self,
2405
+ tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")],
2406
+ 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,
2407
+ _request_timeout: Union[
2408
+ None,
2409
+ Annotated[StrictFloat, Field(gt=0)],
2410
+ Tuple[
2411
+ Annotated[StrictFloat, Field(gt=0)],
2412
+ Annotated[StrictFloat, Field(gt=0)]
2413
+ ]
2414
+ ] = None,
2415
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2416
+ _content_type: Optional[StrictStr] = None,
2417
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2418
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2419
+ ) -> RESTResponseType:
2420
+ """Validate an analytic tenant's metric values
2421
+
2422
+ Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2423
+
2424
+ :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required)
2425
+ :type tenant_id: str
2426
+ :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.
2427
+ :type target_tenant_id: str
2428
+ :param _request_timeout: timeout setting for this request. If one
2429
+ number provided, it will be total request
2430
+ timeout. It can also be a pair (tuple) of
2431
+ (connection, read) timeouts.
2432
+ :type _request_timeout: int, tuple(int, int), optional
2433
+ :param _request_auth: set to override the auth_settings for an a single
2434
+ request; this effectively ignores the
2435
+ authentication in the spec for a single request.
2436
+ :type _request_auth: dict, optional
2437
+ :param _content_type: force content-type for the request.
2438
+ :type _content_type: str, Optional
2439
+ :param _headers: set to override the headers for a single
2440
+ request; this effectively ignores the headers
2441
+ in the spec for a single request.
2442
+ :type _headers: dict, optional
2443
+ :param _host_index: set to override the host_index for a single
2444
+ request; this effectively ignores the host_index
2445
+ in the spec for a single request.
2446
+ :type _host_index: int, optional
2447
+ :return: Returns the result object.
2448
+ """ # noqa: E501
2449
+
2450
+ _param = self._validate_tenant_serialize(
2451
+ tenant_id=tenant_id,
2452
+ target_tenant_id=target_tenant_id,
2453
+ _request_auth=_request_auth,
2454
+ _content_type=_content_type,
2455
+ _headers=_headers,
2456
+ _host_index=_host_index
2457
+ )
2458
+
2459
+ _response_types_map: Dict[str, Optional[str]] = {
2460
+ '200': "DpAutomationTenantPreviewEntriesSummaryDTO",
2461
+ }
2462
+ response_data = self.api_client.call_api(
2463
+ *_param,
2464
+ _request_timeout=_request_timeout
2465
+ )
2466
+ return response_data.response
2467
+
2468
+
2469
+ def _validate_tenant_serialize(
2470
+ self,
2471
+ tenant_id,
2472
+ target_tenant_id,
2473
+ _request_auth,
2474
+ _content_type,
2475
+ _headers,
2476
+ _host_index,
2477
+ ) -> RequestSerialized:
2478
+
2479
+ _host = None
2480
+
2481
+ _collection_formats: Dict[str, str] = {
2482
+ }
2483
+
2484
+ _path_params: Dict[str, str] = {}
2485
+ _query_params: List[Tuple[str, str]] = []
2486
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2487
+ _form_params: List[Tuple[str, str]] = []
2488
+ _files: Dict[
2489
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2490
+ ] = {}
2491
+ _body_params: Optional[bytes] = None
2492
+
2493
+ # process the path parameters
2494
+ if tenant_id is not None:
2495
+ _path_params['tenantId'] = tenant_id
2496
+ # process the query parameters
2497
+ # process the header parameters
2498
+ if target_tenant_id is not None:
2499
+ _header_params['TargetTenantID'] = target_tenant_id
2500
+ # process the form parameters
2501
+ # process the body parameter
2502
+
2503
+
2504
+ # set the HTTP header `Accept`
2505
+ if 'Accept' not in _header_params:
2506
+ _header_params['Accept'] = self.api_client.select_header_accept(
2507
+ [
2508
+ 'application/json'
2509
+ ]
2510
+ )
2511
+
2512
+
2513
+ # authentication setting
2514
+ _auth_settings: List[str] = [
2515
+ 'CookieAuth',
2516
+ 'ApiKeyAuth',
2517
+ 'OAuth2Auth',
2518
+ 'OAuth2Auth',
2519
+ 'BearerAuth'
2520
+ ]
2521
+
2522
+ return self.api_client.param_serialize(
2523
+ method='GET',
2524
+ resource_path='/v1/op/validation/tenants/{tenantId}',
2525
+ path_params=_path_params,
2526
+ query_params=_query_params,
2527
+ header_params=_header_params,
2528
+ body=_body_params,
2529
+ post_params=_form_params,
2530
+ files=_files,
2531
+ auth_settings=_auth_settings,
2532
+ collection_formats=_collection_formats,
2533
+ _host=_host,
2534
+ _request_auth=_request_auth
2535
+ )
2536
+
2537
+
2538
+
2539
+
2540
+ @validate_call
2541
+ def validate_tenants(
2542
+ self,
2543
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
2544
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
2545
+ 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,
2546
+ _request_timeout: Union[
2547
+ None,
2548
+ Annotated[StrictFloat, Field(gt=0)],
2549
+ Tuple[
2550
+ Annotated[StrictFloat, Field(gt=0)],
2551
+ Annotated[StrictFloat, Field(gt=0)]
2552
+ ]
2553
+ ] = None,
2554
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2555
+ _content_type: Optional[StrictStr] = None,
2556
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2557
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2558
+ ) -> DpAutomationTenantPreviewEntriesSummaryListDTO:
2559
+ """Validate metric values for all analytic tenants
2560
+
2561
+ As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2562
+
2563
+ :param limit: The limit of analytic tenant details to retrieve.
2564
+ :type limit: int
2565
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
2566
+ :type start: int
2567
+ :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.
2568
+ :type target_tenant_id: str
2569
+ :param _request_timeout: timeout setting for this request. If one
2570
+ number provided, it will be total request
2571
+ timeout. It can also be a pair (tuple) of
2572
+ (connection, read) timeouts.
2573
+ :type _request_timeout: int, tuple(int, int), optional
2574
+ :param _request_auth: set to override the auth_settings for an a single
2575
+ request; this effectively ignores the
2576
+ authentication in the spec for a single request.
2577
+ :type _request_auth: dict, optional
2578
+ :param _content_type: force content-type for the request.
2579
+ :type _content_type: str, Optional
2580
+ :param _headers: set to override the headers for a single
2581
+ request; this effectively ignores the headers
2582
+ in the spec for a single request.
2583
+ :type _headers: dict, optional
2584
+ :param _host_index: set to override the host_index for a single
2585
+ request; this effectively ignores the host_index
2586
+ in the spec for a single request.
2587
+ :type _host_index: int, optional
2588
+ :return: Returns the result object.
2589
+ """ # noqa: E501
2590
+
2591
+ _param = self._validate_tenants_serialize(
2592
+ limit=limit,
2593
+ start=start,
2594
+ target_tenant_id=target_tenant_id,
2595
+ _request_auth=_request_auth,
2596
+ _content_type=_content_type,
2597
+ _headers=_headers,
2598
+ _host_index=_host_index
2599
+ )
2600
+
2601
+ _response_types_map: Dict[str, Optional[str]] = {
2602
+ '200': "DpAutomationTenantPreviewEntriesSummaryListDTO",
2603
+ }
2604
+ response_data = self.api_client.call_api(
2605
+ *_param,
2606
+ _request_timeout=_request_timeout
2607
+ )
2608
+ response_data.read()
2609
+ return self.api_client.response_deserialize(
2610
+ response_data=response_data,
2611
+ response_types_map=_response_types_map,
2612
+ ).data
2613
+
2614
+
2615
+ @validate_call
2616
+ def validate_tenants_with_http_info(
2617
+ self,
2618
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
2619
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
2620
+ 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,
2621
+ _request_timeout: Union[
2622
+ None,
2623
+ Annotated[StrictFloat, Field(gt=0)],
2624
+ Tuple[
2625
+ Annotated[StrictFloat, Field(gt=0)],
2626
+ Annotated[StrictFloat, Field(gt=0)]
2627
+ ]
2628
+ ] = None,
2629
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2630
+ _content_type: Optional[StrictStr] = None,
2631
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2632
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2633
+ ) -> ApiResponse[DpAutomationTenantPreviewEntriesSummaryListDTO]:
2634
+ """Validate metric values for all analytic tenants
2635
+
2636
+ As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2637
+
2638
+ :param limit: The limit of analytic tenant details to retrieve.
2639
+ :type limit: int
2640
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
2641
+ :type start: int
2642
+ :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.
2643
+ :type target_tenant_id: str
2644
+ :param _request_timeout: timeout setting for this request. If one
2645
+ number provided, it will be total request
2646
+ timeout. It can also be a pair (tuple) of
2647
+ (connection, read) timeouts.
2648
+ :type _request_timeout: int, tuple(int, int), optional
2649
+ :param _request_auth: set to override the auth_settings for an a single
2650
+ request; this effectively ignores the
2651
+ authentication in the spec for a single request.
2652
+ :type _request_auth: dict, optional
2653
+ :param _content_type: force content-type for the request.
2654
+ :type _content_type: str, Optional
2655
+ :param _headers: set to override the headers for a single
2656
+ request; this effectively ignores the headers
2657
+ in the spec for a single request.
2658
+ :type _headers: dict, optional
2659
+ :param _host_index: set to override the host_index for a single
2660
+ request; this effectively ignores the host_index
2661
+ in the spec for a single request.
2662
+ :type _host_index: int, optional
2663
+ :return: Returns the result object.
2664
+ """ # noqa: E501
2665
+
2666
+ _param = self._validate_tenants_serialize(
2667
+ limit=limit,
2668
+ start=start,
2669
+ target_tenant_id=target_tenant_id,
2670
+ _request_auth=_request_auth,
2671
+ _content_type=_content_type,
2672
+ _headers=_headers,
2673
+ _host_index=_host_index
2674
+ )
2675
+
2676
+ _response_types_map: Dict[str, Optional[str]] = {
2677
+ '200': "DpAutomationTenantPreviewEntriesSummaryListDTO",
2678
+ }
2679
+ response_data = self.api_client.call_api(
2680
+ *_param,
2681
+ _request_timeout=_request_timeout
2682
+ )
2683
+ response_data.read()
2684
+ return self.api_client.response_deserialize(
2685
+ response_data=response_data,
2686
+ response_types_map=_response_types_map,
2687
+ )
2688
+
2689
+
2690
+ @validate_call
2691
+ def validate_tenants_without_preload_content(
2692
+ self,
2693
+ limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None,
2694
+ start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None,
2695
+ 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,
2696
+ _request_timeout: Union[
2697
+ None,
2698
+ Annotated[StrictFloat, Field(gt=0)],
2699
+ Tuple[
2700
+ Annotated[StrictFloat, Field(gt=0)],
2701
+ Annotated[StrictFloat, Field(gt=0)]
2702
+ ]
2703
+ ] = None,
2704
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2705
+ _content_type: Optional[StrictStr] = None,
2706
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2707
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2708
+ ) -> RESTResponseType:
2709
+ """Validate metric values for all analytic tenants
2710
+
2711
+ As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production.
2712
+
2713
+ :param limit: The limit of analytic tenant details to retrieve.
2714
+ :type limit: int
2715
+ :param start: The index to start retrieving results from, also known as offset. The index begins at 0.
2716
+ :type start: int
2717
+ :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.
2718
+ :type target_tenant_id: str
2719
+ :param _request_timeout: timeout setting for this request. If one
2720
+ number provided, it will be total request
2721
+ timeout. It can also be a pair (tuple) of
2722
+ (connection, read) timeouts.
2723
+ :type _request_timeout: int, tuple(int, int), optional
2724
+ :param _request_auth: set to override the auth_settings for an a single
2725
+ request; this effectively ignores the
2726
+ authentication in the spec for a single request.
2727
+ :type _request_auth: dict, optional
2728
+ :param _content_type: force content-type for the request.
2729
+ :type _content_type: str, Optional
2730
+ :param _headers: set to override the headers for a single
2731
+ request; this effectively ignores the headers
2732
+ in the spec for a single request.
2733
+ :type _headers: dict, optional
2734
+ :param _host_index: set to override the host_index for a single
2735
+ request; this effectively ignores the host_index
2736
+ in the spec for a single request.
2737
+ :type _host_index: int, optional
2738
+ :return: Returns the result object.
2739
+ """ # noqa: E501
2740
+
2741
+ _param = self._validate_tenants_serialize(
2742
+ limit=limit,
2743
+ start=start,
2744
+ target_tenant_id=target_tenant_id,
2745
+ _request_auth=_request_auth,
2746
+ _content_type=_content_type,
2747
+ _headers=_headers,
2748
+ _host_index=_host_index
2749
+ )
2750
+
2751
+ _response_types_map: Dict[str, Optional[str]] = {
2752
+ '200': "DpAutomationTenantPreviewEntriesSummaryListDTO",
2753
+ }
2754
+ response_data = self.api_client.call_api(
2755
+ *_param,
2756
+ _request_timeout=_request_timeout
2757
+ )
2758
+ return response_data.response
2759
+
2760
+
2761
+ def _validate_tenants_serialize(
2762
+ self,
2763
+ limit,
2764
+ start,
2765
+ target_tenant_id,
2766
+ _request_auth,
2767
+ _content_type,
2768
+ _headers,
2769
+ _host_index,
2770
+ ) -> RequestSerialized:
2771
+
2772
+ _host = None
2773
+
2774
+ _collection_formats: Dict[str, str] = {
2775
+ }
2776
+
2777
+ _path_params: Dict[str, str] = {}
2778
+ _query_params: List[Tuple[str, str]] = []
2779
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2780
+ _form_params: List[Tuple[str, str]] = []
2781
+ _files: Dict[
2782
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2783
+ ] = {}
2784
+ _body_params: Optional[bytes] = None
2785
+
2786
+ # process the path parameters
2787
+ # process the query parameters
2788
+ if limit is not None:
2789
+
2790
+ _query_params.append(('limit', limit))
2791
+
2792
+ if start is not None:
2793
+
2794
+ _query_params.append(('start', start))
2795
+
2796
+ # process the header parameters
2797
+ if target_tenant_id is not None:
2798
+ _header_params['TargetTenantID'] = target_tenant_id
2799
+ # process the form parameters
2800
+ # process the body parameter
2801
+
2802
+
2803
+ # set the HTTP header `Accept`
2804
+ if 'Accept' not in _header_params:
2805
+ _header_params['Accept'] = self.api_client.select_header_accept(
2806
+ [
2807
+ 'application/json'
2808
+ ]
2809
+ )
2810
+
2811
+
2812
+ # authentication setting
2813
+ _auth_settings: List[str] = [
2814
+ 'CookieAuth',
2815
+ 'ApiKeyAuth',
2816
+ 'OAuth2Auth',
2817
+ 'OAuth2Auth',
2818
+ 'BearerAuth'
2819
+ ]
2820
+
2821
+ return self.api_client.param_serialize(
2822
+ method='GET',
2823
+ resource_path='/v1/op/validation/tenants',
2824
+ path_params=_path_params,
2825
+ query_params=_query_params,
2826
+ header_params=_header_params,
2827
+ body=_body_params,
2828
+ post_params=_form_params,
2829
+ files=_files,
2830
+ auth_settings=_auth_settings,
2831
+ collection_formats=_collection_formats,
2832
+ _host=_host,
2833
+ _request_auth=_request_auth
2834
+ )
2835
+
2836
+