visier-platform-sdk 22222222.99200.21494__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 (692) hide show
  1. visier_platform_sdk/__init__.py +1404 -0
  2. visier_platform_sdk/api/__init__.py +43 -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 +8380 -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/dimensions_v2_api.py +2344 -0
  15. visier_platform_sdk/api/direct_data_intake_api.py +3039 -0
  16. visier_platform_sdk/api/email_domains_api.py +843 -0
  17. visier_platform_sdk/api/encryption_keys_api.py +835 -0
  18. visier_platform_sdk/api/jobs_library_api.py +1168 -0
  19. visier_platform_sdk/api/network_subnets_api.py +1170 -0
  20. visier_platform_sdk/api/o_auth2_api.py +1036 -0
  21. visier_platform_sdk/api/object_configuration_api.py +1752 -0
  22. visier_platform_sdk/api/permissions_api.py +4295 -0
  23. visier_platform_sdk/api/pgp_keys_api.py +1161 -0
  24. visier_platform_sdk/api/planning_data_load_api.py +740 -0
  25. visier_platform_sdk/api/production_versions_api.py +944 -0
  26. visier_platform_sdk/api/profiles_api.py +2873 -0
  27. visier_platform_sdk/api/projects_api.py +2128 -0
  28. visier_platform_sdk/api/release_version_configuration_api.py +835 -0
  29. visier_platform_sdk/api/reporting_api.py +1757 -0
  30. visier_platform_sdk/api/search_api.py +356 -0
  31. visier_platform_sdk/api/skills_library_api.py +2632 -0
  32. visier_platform_sdk/api/source_files_download_api.py +335 -0
  33. visier_platform_sdk/api/sources_api.py +652 -0
  34. visier_platform_sdk/api/system_status_api.py +570 -0
  35. visier_platform_sdk/api/tenants_v1_api.py +2836 -0
  36. visier_platform_sdk/api/tenants_v2_api.py +1595 -0
  37. visier_platform_sdk/api/user_groups_v2_api.py +2332 -0
  38. visier_platform_sdk/api/users_v1_api.py +6157 -0
  39. visier_platform_sdk/api/users_v2_api.py +973 -0
  40. visier_platform_sdk/api/vee_api.py +1161 -0
  41. visier_platform_sdk/api/webhooks_api.py +2281 -0
  42. visier_platform_sdk/api_client.py +811 -0
  43. visier_platform_sdk/api_response.py +21 -0
  44. visier_platform_sdk/configuration.py +808 -0
  45. visier_platform_sdk/exceptions.py +217 -0
  46. visier_platform_sdk/models/__init__.py +657 -0
  47. visier_platform_sdk/models/accessible_tenant_profile_assignment_request_dto.py +102 -0
  48. visier_platform_sdk/models/accessible_tenant_profile_assignment_response_dto.py +128 -0
  49. visier_platform_sdk/models/accessible_tenant_profile_revoke_request_dto.py +98 -0
  50. visier_platform_sdk/models/accessible_tenant_profile_revoke_response_dto.py +125 -0
  51. visier_platform_sdk/models/additional_capabilities_dto.py +88 -0
  52. visier_platform_sdk/models/admin_capability_config_dto.py +90 -0
  53. visier_platform_sdk/models/adp_auth_params_dto.py +88 -0
  54. visier_platform_sdk/models/aggregation_query_dto.py +128 -0
  55. visier_platform_sdk/models/aggregation_query_execution_dto.py +98 -0
  56. visier_platform_sdk/models/aggregation_query_source_dto.py +96 -0
  57. visier_platform_sdk/models/aggregation_query_source_metric_dto.py +94 -0
  58. visier_platform_sdk/models/aggregation_query_source_metrics_dto.py +96 -0
  59. visier_platform_sdk/models/aggregation_type_option_dto.py +96 -0
  60. visier_platform_sdk/models/aggregation_type_parameter_dto.py +102 -0
  61. visier_platform_sdk/models/aggregation_type_parameter_value_dto.py +90 -0
  62. visier_platform_sdk/models/all_permissions_assigned_for_local_tenant_dto.py +96 -0
  63. visier_platform_sdk/models/all_profile_assigned_for_accessible_tenant_dto.py +96 -0
  64. visier_platform_sdk/models/all_profile_assigned_for_local_tenant_dto.py +96 -0
  65. visier_platform_sdk/models/all_tenants_status_apidto.py +100 -0
  66. visier_platform_sdk/models/all_user_groups_assigned_for_local_tenant_dto.py +96 -0
  67. visier_platform_sdk/models/all_users_get_api_response_dto.py +100 -0
  68. visier_platform_sdk/models/analytic_object_definition_dto.py +102 -0
  69. visier_platform_sdk/models/analytic_object_dto.py +132 -0
  70. visier_platform_sdk/models/analytic_object_filter_dto.py +94 -0
  71. visier_platform_sdk/models/analytic_object_filter_list_dto.py +96 -0
  72. visier_platform_sdk/models/analytic_object_names_dto.py +88 -0
  73. visier_platform_sdk/models/analytic_object_reference_dto.py +88 -0
  74. visier_platform_sdk/models/analytic_object_reference_list_dto.py +96 -0
  75. visier_platform_sdk/models/analytic_object_request_dto.py +96 -0
  76. visier_platform_sdk/models/analytic_object_with_context_dto.py +98 -0
  77. visier_platform_sdk/models/analytic_objects_dto.py +96 -0
  78. visier_platform_sdk/models/any.py +101 -0
  79. visier_platform_sdk/models/api_error.py +92 -0
  80. visier_platform_sdk/models/assign_connector_credential_request.py +96 -0
  81. visier_platform_sdk/models/assign_connector_credentials_by_tenant_response_dto.py +112 -0
  82. visier_platform_sdk/models/assign_connector_credentials_response_dto.py +96 -0
  83. visier_platform_sdk/models/assign_connector_with_credentials_response_dto.py +98 -0
  84. visier_platform_sdk/models/assign_revoke_permission_by_permission_dto.py +102 -0
  85. visier_platform_sdk/models/assign_revoke_permission_by_tenant_dto.py +114 -0
  86. visier_platform_sdk/models/assign_revoke_permission_by_user_dto.py +92 -0
  87. visier_platform_sdk/models/assign_revoke_permission_request_dto.py +90 -0
  88. visier_platform_sdk/models/assign_revoke_permissions_request_dto.py +102 -0
  89. visier_platform_sdk/models/assign_revoke_permissions_response_dto.py +96 -0
  90. visier_platform_sdk/models/assigned_credential_info_response_dto.py +92 -0
  91. visier_platform_sdk/models/bamboo_auth_params_dto.py +90 -0
  92. visier_platform_sdk/models/basic_information_dto.py +102 -0
  93. visier_platform_sdk/models/basic_s3_auth_params_dto.py +96 -0
  94. visier_platform_sdk/models/batch_tenant_provision_apidto.py +96 -0
  95. visier_platform_sdk/models/benchmark_info.py +92 -0
  96. visier_platform_sdk/models/benchmark_value.py +108 -0
  97. visier_platform_sdk/models/big_query_auth_params_dto.py +104 -0
  98. visier_platform_sdk/models/big_query_service_account_params_dto.py +90 -0
  99. visier_platform_sdk/models/bulk_change_response_dto.py +106 -0
  100. visier_platform_sdk/models/bulk_data_access_set_response_dto.py +106 -0
  101. visier_platform_sdk/models/business_location_dto.py +90 -0
  102. visier_platform_sdk/models/calculated_property_type_dto.py +90 -0
  103. visier_platform_sdk/models/calculated_selection_concept_dto.py +104 -0
  104. visier_platform_sdk/models/calculation_concept_configuration_dto.py +96 -0
  105. visier_platform_sdk/models/calculation_concept_configuration_map_dto.py +96 -0
  106. visier_platform_sdk/models/calculation_concept_dto.py +96 -0
  107. visier_platform_sdk/models/calculation_concept_list_dto.py +96 -0
  108. visier_platform_sdk/models/cancel_job_batch_from_job_id_dto.py +88 -0
  109. visier_platform_sdk/models/capabilities_dto.py +92 -0
  110. visier_platform_sdk/models/capability_dto.py +92 -0
  111. visier_platform_sdk/models/capability_group_dto.py +146 -0
  112. visier_platform_sdk/models/cell_distribution_bin_dto.py +90 -0
  113. visier_platform_sdk/models/cell_distribution_options_dto.py +88 -0
  114. visier_platform_sdk/models/cell_dto.py +102 -0
  115. visier_platform_sdk/models/cell_set_axis_dto.py +102 -0
  116. visier_platform_sdk/models/cell_set_axis_position_dto.py +92 -0
  117. visier_platform_sdk/models/cell_set_dto.py +114 -0
  118. visier_platform_sdk/models/cell_set_or_error_dto.py +98 -0
  119. visier_platform_sdk/models/clone_files_into_source_parameters_dto.py +96 -0
  120. visier_platform_sdk/models/cohort_filter_dto.py +100 -0
  121. visier_platform_sdk/models/commit_and_publish_operation_response_dto.py +92 -0
  122. visier_platform_sdk/models/commit_dto.py +92 -0
  123. visier_platform_sdk/models/concept_configuration_result_dto.py +92 -0
  124. visier_platform_sdk/models/concept_definition_dto.py +108 -0
  125. visier_platform_sdk/models/concept_delete_request_dto.py +96 -0
  126. visier_platform_sdk/models/concept_delete_with_context_dto.py +98 -0
  127. visier_platform_sdk/models/concept_request_dto.py +96 -0
  128. visier_platform_sdk/models/concept_response_dto.py +96 -0
  129. visier_platform_sdk/models/concept_type_details_dto.py +104 -0
  130. visier_platform_sdk/models/concept_with_context_dto.py +98 -0
  131. visier_platform_sdk/models/connector.py +98 -0
  132. visier_platform_sdk/models/connector_info_response_dto.py +92 -0
  133. visier_platform_sdk/models/connector_setting_request_dto.py +90 -0
  134. visier_platform_sdk/models/connector_setting_response_dto.py +92 -0
  135. visier_platform_sdk/models/connector_settings_response_dto.py +102 -0
  136. visier_platform_sdk/models/consolidated_analytics_api_excluded_source_list_dto.py +88 -0
  137. visier_platform_sdk/models/consolidated_analytics_api_source_tenant_list_dto.py +88 -0
  138. visier_platform_sdk/models/consolidated_analytics_api_tenant_create_request_dto.py +88 -0
  139. visier_platform_sdk/models/consolidated_analytics_api_tenant_list_response_dto.py +88 -0
  140. visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details.py +92 -0
  141. visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details_list_response_dto.py +96 -0
  142. visier_platform_sdk/models/consolidated_analytics_job_request_dto.py +88 -0
  143. visier_platform_sdk/models/content_package_dto.py +92 -0
  144. visier_platform_sdk/models/copy_s3_auth_params_dto.py +88 -0
  145. visier_platform_sdk/models/create_data_access_set_request_dto.py +96 -0
  146. visier_platform_sdk/models/credential_creation_api_response_dto.py +102 -0
  147. visier_platform_sdk/models/currencies_dto.py +96 -0
  148. visier_platform_sdk/models/currency_dto.py +94 -0
  149. visier_platform_sdk/models/currency_rate_dto.py +96 -0
  150. visier_platform_sdk/models/currency_rates_dto.py +96 -0
  151. visier_platform_sdk/models/custom_property_dto.py +90 -0
  152. visier_platform_sdk/models/custom_tenant_property_dto.py +90 -0
  153. visier_platform_sdk/models/data_access_set_dto.py +104 -0
  154. visier_platform_sdk/models/data_access_set_error_dto.py +90 -0
  155. visier_platform_sdk/models/data_access_set_failure_dto.py +96 -0
  156. visier_platform_sdk/models/data_access_set_success_dto.py +90 -0
  157. visier_platform_sdk/models/data_categories_response_dto.py +96 -0
  158. visier_platform_sdk/models/data_category_response_dto.py +92 -0
  159. visier_platform_sdk/models/data_load_request.py +92 -0
  160. visier_platform_sdk/models/data_load_request_model.py +90 -0
  161. visier_platform_sdk/models/data_load_response.py +88 -0
  162. visier_platform_sdk/models/data_model_analytic_object_dto.py +130 -0
  163. visier_platform_sdk/models/data_provider_auth_information_dto.py +104 -0
  164. visier_platform_sdk/models/data_provider_auth_params_dto.py +344 -0
  165. visier_platform_sdk/models/data_provider_basic_information_dto.py +90 -0
  166. visier_platform_sdk/models/data_provider_basic_metadata_dto.py +88 -0
  167. visier_platform_sdk/models/data_security_profile_dto.py +134 -0
  168. visier_platform_sdk/models/data_transfer_result_detail.py +94 -0
  169. visier_platform_sdk/models/data_version_and_date_dto.py +90 -0
  170. visier_platform_sdk/models/data_version_export_column_dto.py +94 -0
  171. visier_platform_sdk/models/data_version_export_data_version_summary_dto.py +92 -0
  172. visier_platform_sdk/models/data_version_export_data_versions_dto.py +96 -0
  173. visier_platform_sdk/models/data_version_export_dto.py +108 -0
  174. visier_platform_sdk/models/data_version_export_file_dto.py +106 -0
  175. visier_platform_sdk/models/data_version_export_job_status_dto.py +94 -0
  176. visier_platform_sdk/models/data_version_export_part_file_dto.py +90 -0
  177. visier_platform_sdk/models/data_version_export_schedule_job_request_dto.py +90 -0
  178. visier_platform_sdk/models/data_version_export_schedule_job_response_dto.py +88 -0
  179. visier_platform_sdk/models/data_version_export_table_dto.py +101 -0
  180. visier_platform_sdk/models/data_version_exports_dto.py +96 -0
  181. visier_platform_sdk/models/data_version_object.py +92 -0
  182. visier_platform_sdk/models/databricks_auth_params_dto.py +94 -0
  183. visier_platform_sdk/models/date_range_dto.py +90 -0
  184. visier_platform_sdk/models/dayforce_v2_auth_params_dto.py +96 -0
  185. visier_platform_sdk/models/delete_permissions_request_dto.py +88 -0
  186. visier_platform_sdk/models/delete_user_group_v2_request.py +88 -0
  187. visier_platform_sdk/models/dependent_dto.py +92 -0
  188. visier_platform_sdk/models/description_entry.py +90 -0
  189. visier_platform_sdk/models/designer_dimension_filter_dto.py +100 -0
  190. visier_platform_sdk/models/designer_selection_concept_dto.py +96 -0
  191. visier_platform_sdk/models/dimension_change_definition_dto.py +94 -0
  192. visier_platform_sdk/models/dimension_change_definitions_by_tenant_dto.py +100 -0
  193. visier_platform_sdk/models/dimension_delete_request_dto.py +96 -0
  194. visier_platform_sdk/models/dimension_delete_with_context_dto.py +98 -0
  195. visier_platform_sdk/models/dimension_details_dto.py +98 -0
  196. visier_platform_sdk/models/dimension_dto.py +120 -0
  197. visier_platform_sdk/models/dimension_filter_dto.py +100 -0
  198. visier_platform_sdk/models/dimension_filter_list_dto.py +96 -0
  199. visier_platform_sdk/models/dimension_mapping_validation_dto.py +102 -0
  200. visier_platform_sdk/models/dimension_mapping_validation_execution_dto.py +90 -0
  201. visier_platform_sdk/models/dimension_member.py +139 -0
  202. visier_platform_sdk/models/dimension_member_dto.py +88 -0
  203. visier_platform_sdk/models/dimension_member_reference_dto.py +90 -0
  204. visier_platform_sdk/models/dimension_reference_dto.py +90 -0
  205. visier_platform_sdk/models/dimension_request_dto.py +96 -0
  206. visier_platform_sdk/models/dimension_response_dto.py +96 -0
  207. visier_platform_sdk/models/dimension_with_context_dto.py +98 -0
  208. visier_platform_sdk/models/dimensions_auth_params_dto.py +98 -0
  209. visier_platform_sdk/models/dimensions_change_definitions_dto.py +96 -0
  210. visier_platform_sdk/models/dimensions_dto.py +96 -0
  211. visier_platform_sdk/models/direct_data_job_config_dto.py +100 -0
  212. visier_platform_sdk/models/direct_data_job_status_response_dto.py +96 -0
  213. visier_platform_sdk/models/direct_data_list_transactions_response_dto.py +96 -0
  214. visier_platform_sdk/models/direct_data_load_config_dto.py +92 -0
  215. visier_platform_sdk/models/direct_data_schema_dto.py +96 -0
  216. visier_platform_sdk/models/direct_data_schema_field_dto.py +96 -0
  217. visier_platform_sdk/models/direct_data_transaction_dto.py +96 -0
  218. visier_platform_sdk/models/direct_data_transaction_start_response_dto.py +88 -0
  219. visier_platform_sdk/models/direct_data_upload_file_response_dto.py +92 -0
  220. visier_platform_sdk/models/disable_dv_model.py +96 -0
  221. visier_platform_sdk/models/disable_dv_request.py +92 -0
  222. visier_platform_sdk/models/disable_dv_response.py +100 -0
  223. visier_platform_sdk/models/dispatching_job_status_response.py +94 -0
  224. visier_platform_sdk/models/document_search_link_dto.py +90 -0
  225. visier_platform_sdk/models/download_source_files_dto.py +102 -0
  226. visier_platform_sdk/models/download_source_files_response_dto.py +90 -0
  227. visier_platform_sdk/models/dv_export_status.py +96 -0
  228. visier_platform_sdk/models/dynamic_dimension_filter_dto.py +112 -0
  229. visier_platform_sdk/models/dynamic_property_mapping_dto.py +106 -0
  230. visier_platform_sdk/models/element_ids_dto.py +88 -0
  231. visier_platform_sdk/models/email_domains_dto.py +90 -0
  232. visier_platform_sdk/models/error_dto.py +92 -0
  233. visier_platform_sdk/models/exclude_data_uploads_request.py +96 -0
  234. visier_platform_sdk/models/excluded_sources_body.py +88 -0
  235. visier_platform_sdk/models/execution_context_dto.py +90 -0
  236. visier_platform_sdk/models/export_production_versions_api_operation_parameters_dto.py +92 -0
  237. visier_platform_sdk/models/extract_data_and_load_dto.py +150 -0
  238. visier_platform_sdk/models/extracted_skill.py +94 -0
  239. visier_platform_sdk/models/extraction_job.py +94 -0
  240. visier_platform_sdk/models/extraction_job_and_status_response.py +104 -0
  241. visier_platform_sdk/models/extractor_credential_apidto.py +96 -0
  242. visier_platform_sdk/models/extractor_credentials_apidto.py +100 -0
  243. visier_platform_sdk/models/extractor_setting_apidto.py +100 -0
  244. visier_platform_sdk/models/extractor_setting_key_value_apidto.py +90 -0
  245. visier_platform_sdk/models/extractor_settings_apidto.py +96 -0
  246. visier_platform_sdk/models/failed_accessible_tenant_profile_assignment_dto.py +98 -0
  247. visier_platform_sdk/models/failed_change_dto.py +100 -0
  248. visier_platform_sdk/models/failed_local_tenant_profile_assignment_dto.py +94 -0
  249. visier_platform_sdk/models/failed_local_tenant_profile_revoke_dto.py +90 -0
  250. visier_platform_sdk/models/fusion_auth_params_dto.py +92 -0
  251. visier_platform_sdk/models/generate_impersonation_token_request.py +88 -0
  252. visier_platform_sdk/models/generate_key_request_dto.py +92 -0
  253. visier_platform_sdk/models/get_capabilities_api_response_dto.py +96 -0
  254. visier_platform_sdk/models/get_content_packages_api_response_dto.py +96 -0
  255. visier_platform_sdk/models/get_data_access_sets_api_response_dto.py +96 -0
  256. visier_platform_sdk/models/get_data_security_objects_api_response_dto.py +96 -0
  257. visier_platform_sdk/models/get_permissions_api_response_dto.py +96 -0
  258. visier_platform_sdk/models/get_plan_list_response_dto.py +98 -0
  259. visier_platform_sdk/models/get_production_versions_api_response_dto.py +96 -0
  260. visier_platform_sdk/models/get_projects_api_response_dto.py +123 -0
  261. visier_platform_sdk/models/gong_auth_params_dto.py +90 -0
  262. visier_platform_sdk/models/google_sheets_auth_params_dto.py +94 -0
  263. visier_platform_sdk/models/google_workspace_auth_params_dto.py +96 -0
  264. visier_platform_sdk/models/greenhouse_auth_params_dto.py +88 -0
  265. visier_platform_sdk/models/hierarchy.py +92 -0
  266. visier_platform_sdk/models/hierarchy_property_dto.py +90 -0
  267. visier_platform_sdk/models/home_analysis_by_user_group_dto.py +90 -0
  268. visier_platform_sdk/models/icims_auth_params_dto.py +108 -0
  269. visier_platform_sdk/models/import_definition_apidto.py +92 -0
  270. visier_platform_sdk/models/import_definitions_apidto.py +100 -0
  271. visier_platform_sdk/models/include_data_uploads_request.py +96 -0
  272. visier_platform_sdk/models/inherited_access_config_dto.py +100 -0
  273. visier_platform_sdk/models/inherited_reference_member_filter_config_dto.py +90 -0
  274. visier_platform_sdk/models/internal_query_execution_options_dto.py +100 -0
  275. visier_platform_sdk/models/internal_s3_auth_params_dto.py +90 -0
  276. visier_platform_sdk/models/jdbc_auth_params_dto.py +92 -0
  277. visier_platform_sdk/models/jira_auth_params_dto.py +96 -0
  278. visier_platform_sdk/models/jira_connect_params_dto.py +92 -0
  279. visier_platform_sdk/models/job.py +121 -0
  280. visier_platform_sdk/models/job_cancellation_result_dto.py +110 -0
  281. visier_platform_sdk/models/job_cancellation_results_dto.py +96 -0
  282. visier_platform_sdk/models/job_entry.py +92 -0
  283. visier_platform_sdk/models/job_feedback_input.py +92 -0
  284. visier_platform_sdk/models/job_id_response.py +88 -0
  285. visier_platform_sdk/models/job_search_failure_output.py +94 -0
  286. visier_platform_sdk/models/job_search_input.py +88 -0
  287. visier_platform_sdk/models/job_search_output.py +106 -0
  288. visier_platform_sdk/models/job_standardization_input.py +98 -0
  289. visier_platform_sdk/models/job_standardization_input_skills.py +90 -0
  290. visier_platform_sdk/models/job_status_list_response.py +100 -0
  291. visier_platform_sdk/models/job_status_with_start_time.py +96 -0
  292. visier_platform_sdk/models/key_group_filter_dto.py +96 -0
  293. visier_platform_sdk/models/key_group_filter_item_dto.py +100 -0
  294. visier_platform_sdk/models/key_name.py +88 -0
  295. visier_platform_sdk/models/key_pair_delete_response_dto.py +88 -0
  296. visier_platform_sdk/models/key_pair_generate_request_dto.py +88 -0
  297. visier_platform_sdk/models/last_login_dto.py +88 -0
  298. visier_platform_sdk/models/level_dto.py +92 -0
  299. visier_platform_sdk/models/level_list_dto.py +96 -0
  300. visier_platform_sdk/models/leveled_details_dto.py +102 -0
  301. visier_platform_sdk/models/lever_auth_params_dto.py +88 -0
  302. visier_platform_sdk/models/lineage_dto.py +100 -0
  303. visier_platform_sdk/models/list_query_execution_dto.py +144 -0
  304. visier_platform_sdk/models/list_query_execution_options_dto.py +158 -0
  305. visier_platform_sdk/models/list_query_source_dto.py +94 -0
  306. visier_platform_sdk/models/list_response.py +101 -0
  307. visier_platform_sdk/models/local_tenant_profile_assignment_request_dto.py +92 -0
  308. visier_platform_sdk/models/local_tenant_profile_assignment_response_dto.py +118 -0
  309. visier_platform_sdk/models/local_tenant_profile_revoke_request_dto.py +88 -0
  310. visier_platform_sdk/models/local_tenant_profile_revoke_response_dto.py +106 -0
  311. visier_platform_sdk/models/location_search_failure_output.py +96 -0
  312. visier_platform_sdk/models/location_search_input.py +98 -0
  313. visier_platform_sdk/models/location_search_input1.py +92 -0
  314. visier_platform_sdk/models/location_search_output.py +106 -0
  315. visier_platform_sdk/models/location_search_successful_output.py +98 -0
  316. visier_platform_sdk/models/mask_message.py +88 -0
  317. visier_platform_sdk/models/medallia_auth_params_dto.py +94 -0
  318. visier_platform_sdk/models/member_dto.py +106 -0
  319. visier_platform_sdk/models/member_filter_config_dto.py +96 -0
  320. visier_platform_sdk/models/member_filter_dto.py +98 -0
  321. visier_platform_sdk/models/member_parameter_definition_dto.py +102 -0
  322. visier_platform_sdk/models/member_parameter_value_dto.py +98 -0
  323. visier_platform_sdk/models/member_selection_concept_dto.py +102 -0
  324. visier_platform_sdk/models/member_selection_dto.py +90 -0
  325. visier_platform_sdk/models/member_selection_list_dto.py +96 -0
  326. visier_platform_sdk/models/member_values_dto.py +105 -0
  327. visier_platform_sdk/models/members_dto.py +96 -0
  328. visier_platform_sdk/models/metric_definition_dto.py +114 -0
  329. visier_platform_sdk/models/metric_dto.py +122 -0
  330. visier_platform_sdk/models/metric_type_details_dto.py +92 -0
  331. visier_platform_sdk/models/metric_validation_summary_dto.py +92 -0
  332. visier_platform_sdk/models/metrics_dto.py +96 -0
  333. visier_platform_sdk/models/microsoft365_auth_params_dto.py +94 -0
  334. visier_platform_sdk/models/module_settings_dto.py +92 -0
  335. visier_platform_sdk/models/multiple_tenant_data_versions_details_dto.py +98 -0
  336. visier_platform_sdk/models/multiple_tenant_data_versions_list_dto.py +100 -0
  337. visier_platform_sdk/models/my_sql_auth_params_dto.py +98 -0
  338. visier_platform_sdk/models/namely_auth_params_dto.py +88 -0
  339. visier_platform_sdk/models/network_subnets_message_request.py +90 -0
  340. visier_platform_sdk/models/network_subnets_message_response.py +88 -0
  341. visier_platform_sdk/models/numeric_parameter_definition_dto.py +98 -0
  342. visier_platform_sdk/models/numeric_parameter_value_dto.py +90 -0
  343. visier_platform_sdk/models/o_auth2_user_info_dto.py +117 -0
  344. visier_platform_sdk/models/o_auth2_user_subnet_info_dto.py +100 -0
  345. visier_platform_sdk/models/o_auth2_user_tenant_detail_dto.py +96 -0
  346. visier_platform_sdk/models/o_auth2_user_tenant_details_dto.py +96 -0
  347. visier_platform_sdk/models/o_auth2_user_tenant_properties_dto.py +88 -0
  348. visier_platform_sdk/models/object_change_failure_dto.py +98 -0
  349. visier_platform_sdk/models/object_change_success_dto.py +94 -0
  350. visier_platform_sdk/models/object_id_dto.py +90 -0
  351. visier_platform_sdk/models/object_reference_dto.py +110 -0
  352. visier_platform_sdk/models/objects_bulk_change_response_dto.py +106 -0
  353. visier_platform_sdk/models/oracle_db_auth_params_dto.py +96 -0
  354. visier_platform_sdk/models/output_entry.py +98 -0
  355. visier_platform_sdk/models/output_entry1.py +98 -0
  356. visier_platform_sdk/models/output_entry1_matches_inner.py +94 -0
  357. visier_platform_sdk/models/pair_dto.py +90 -0
  358. visier_platform_sdk/models/parameter_definition_dto.py +110 -0
  359. visier_platform_sdk/models/parent_child_details_dto.py +108 -0
  360. visier_platform_sdk/models/permission_assigned_by_tenant_dto.py +98 -0
  361. visier_platform_sdk/models/permission_assigned_for_local_tenant_dto.py +92 -0
  362. visier_platform_sdk/models/permission_assigned_user_dto.py +92 -0
  363. visier_platform_sdk/models/permission_assigned_users_dto.py +100 -0
  364. visier_platform_sdk/models/permission_bulk_operation_response_dto.py +106 -0
  365. visier_platform_sdk/models/permission_dto.py +114 -0
  366. visier_platform_sdk/models/permission_error_dto.py +90 -0
  367. visier_platform_sdk/models/permission_failure_dto.py +96 -0
  368. visier_platform_sdk/models/permission_response_dto.py +90 -0
  369. visier_platform_sdk/models/permission_success_dto.py +90 -0
  370. visier_platform_sdk/models/permissions_list_dto.py +96 -0
  371. visier_platform_sdk/models/permissions_to_user_group_for_tenant_dto.py +102 -0
  372. visier_platform_sdk/models/permissions_to_user_group_request_dto.py +90 -0
  373. visier_platform_sdk/models/permissions_to_user_groups_request_dto.py +96 -0
  374. visier_platform_sdk/models/perspective_configuration_dto.py +100 -0
  375. visier_platform_sdk/models/perspective_node_dto.py +100 -0
  376. visier_platform_sdk/models/plan_data_load_change_dto.py +94 -0
  377. visier_platform_sdk/models/plan_data_load_change_list_dto.py +98 -0
  378. visier_platform_sdk/models/plan_data_load_error_dto.py +92 -0
  379. visier_platform_sdk/models/plan_data_upload_response_dto.py +110 -0
  380. visier_platform_sdk/models/plan_info_dto.py +106 -0
  381. visier_platform_sdk/models/plan_item_dto.py +102 -0
  382. visier_platform_sdk/models/plan_parameter_definition_dto.py +94 -0
  383. visier_platform_sdk/models/plan_parameter_value_dto.py +94 -0
  384. visier_platform_sdk/models/plan_row_data_load_response_dto.py +114 -0
  385. visier_platform_sdk/models/plan_schema_dto.py +126 -0
  386. visier_platform_sdk/models/plan_segment_level_dto.py +96 -0
  387. visier_platform_sdk/models/plan_segment_level_member_dto.py +94 -0
  388. visier_platform_sdk/models/plan_segment_level_member_list_dto.py +100 -0
  389. visier_platform_sdk/models/plan_time_period_dto.py +90 -0
  390. visier_platform_sdk/models/plan_with_schema_dto.py +108 -0
  391. visier_platform_sdk/models/planning_concept_filter_context_dto.py +88 -0
  392. visier_platform_sdk/models/planning_hierarchy_filter_context_dto.py +92 -0
  393. visier_platform_sdk/models/planning_model_dto.py +92 -0
  394. visier_platform_sdk/models/planning_models_dto.py +96 -0
  395. visier_platform_sdk/models/planning_plan_context_dto.py +98 -0
  396. visier_platform_sdk/models/planning_plan_dto.py +123 -0
  397. visier_platform_sdk/models/planning_plans_dto.py +96 -0
  398. visier_platform_sdk/models/population_configuration_dto.py +115 -0
  399. visier_platform_sdk/models/prediction_dto.py +124 -0
  400. visier_platform_sdk/models/predictions_dto.py +96 -0
  401. visier_platform_sdk/models/process_concept_definition_dto.py +128 -0
  402. visier_platform_sdk/models/process_concept_member_dto.py +90 -0
  403. visier_platform_sdk/models/process_concept_member_list_dto.py +96 -0
  404. visier_platform_sdk/models/process_concept_metric_definition_dto.py +92 -0
  405. visier_platform_sdk/models/process_concept_metric_list_dto.py +96 -0
  406. visier_platform_sdk/models/process_concept_outcome_dto.py +114 -0
  407. visier_platform_sdk/models/process_concept_outcome_list_dto.py +96 -0
  408. visier_platform_sdk/models/process_concept_property_list_dto.py +96 -0
  409. visier_platform_sdk/models/process_concept_property_type_dto.py +92 -0
  410. visier_platform_sdk/models/process_concept_stage_dto.py +102 -0
  411. visier_platform_sdk/models/process_concept_stage_list_dto.py +96 -0
  412. visier_platform_sdk/models/processing_job.py +96 -0
  413. visier_platform_sdk/models/processing_job_and_status_response.py +104 -0
  414. visier_platform_sdk/models/processing_job_request_dto.py +96 -0
  415. visier_platform_sdk/models/processing_job_status_response.py +104 -0
  416. visier_platform_sdk/models/product_release_dto.py +94 -0
  417. visier_platform_sdk/models/product_releases_dto.py +96 -0
  418. visier_platform_sdk/models/product_version_dto.py +92 -0
  419. visier_platform_sdk/models/product_versions_dto.py +96 -0
  420. visier_platform_sdk/models/product_versions_update_failure_tenant_response_dto.py +94 -0
  421. visier_platform_sdk/models/product_versions_update_response_dto.py +106 -0
  422. visier_platform_sdk/models/product_versions_update_successful_tenant_response_dto.py +92 -0
  423. visier_platform_sdk/models/production_version_api_operation_request_dto.py +98 -0
  424. visier_platform_sdk/models/production_version_api_operation_response_dto.py +92 -0
  425. visier_platform_sdk/models/production_versions_api_operation_request_dto.py +104 -0
  426. visier_platform_sdk/models/production_versions_api_operation_response_dto.py +88 -0
  427. visier_platform_sdk/models/profile_assigned_for_accessible_tenant_dto.py +98 -0
  428. visier_platform_sdk/models/profile_assigned_for_local_tenant_dto.py +110 -0
  429. visier_platform_sdk/models/profile_get_api_response_dto.py +102 -0
  430. visier_platform_sdk/models/profiles_get_api_response_dto.py +96 -0
  431. visier_platform_sdk/models/project_commits_api_response_dto.py +96 -0
  432. visier_platform_sdk/models/project_dto.py +111 -0
  433. visier_platform_sdk/models/project_operation_request_dto.py +98 -0
  434. visier_platform_sdk/models/project_operation_response_dto.py +92 -0
  435. visier_platform_sdk/models/properties_change_definitions_dto.py +96 -0
  436. visier_platform_sdk/models/properties_delete_definitions_dto.py +100 -0
  437. visier_platform_sdk/models/properties_dto.py +96 -0
  438. visier_platform_sdk/models/property_access_config_dto.py +116 -0
  439. visier_platform_sdk/models/property_bulk_delete_response_dto.py +106 -0
  440. visier_platform_sdk/models/property_change_definition_dto.py +112 -0
  441. visier_platform_sdk/models/property_change_definitions_by_tenant_dto.py +100 -0
  442. visier_platform_sdk/models/property_column_dto.py +94 -0
  443. visier_platform_sdk/models/property_definition_dto.py +102 -0
  444. visier_platform_sdk/models/property_delete_definitions_by_tenant_dto.py +92 -0
  445. visier_platform_sdk/models/property_delete_failure_dto.py +117 -0
  446. visier_platform_sdk/models/property_delete_success_dto.py +113 -0
  447. visier_platform_sdk/models/property_dependency_dto.py +90 -0
  448. visier_platform_sdk/models/property_dependency_list_dto.py +96 -0
  449. visier_platform_sdk/models/property_dto.py +118 -0
  450. visier_platform_sdk/models/property_reference_dto.py +90 -0
  451. visier_platform_sdk/models/property_set_config_dto.py +102 -0
  452. visier_platform_sdk/models/property_type_details_dto.py +104 -0
  453. visier_platform_sdk/models/property_type_dto.py +98 -0
  454. visier_platform_sdk/models/public_key_dto.py +96 -0
  455. visier_platform_sdk/models/public_keys_dto.py +96 -0
  456. visier_platform_sdk/models/push_data_cancel_response.py +102 -0
  457. visier_platform_sdk/models/push_data_column_definition_dto.py +98 -0
  458. visier_platform_sdk/models/push_data_complete_request.py +90 -0
  459. visier_platform_sdk/models/push_data_complete_response.py +104 -0
  460. visier_platform_sdk/models/push_data_response.py +104 -0
  461. visier_platform_sdk/models/push_data_source_definition_dto.py +106 -0
  462. visier_platform_sdk/models/push_data_source_definitions_dto.py +96 -0
  463. visier_platform_sdk/models/put_project_commits_request.py +88 -0
  464. visier_platform_sdk/models/qualifying_path_dto.py +88 -0
  465. visier_platform_sdk/models/qualtrics_auth_params_dto.py +90 -0
  466. visier_platform_sdk/models/query_axis_dto.py +141 -0
  467. visier_platform_sdk/models/query_axis_options_dto.py +100 -0
  468. visier_platform_sdk/models/query_dimension_data_member_selection_dto.py +92 -0
  469. visier_platform_sdk/models/query_dimension_leaf_selection_dto.py +92 -0
  470. visier_platform_sdk/models/query_dimension_level_property_dto.py +108 -0
  471. visier_platform_sdk/models/query_dimension_level_selection_dto.py +96 -0
  472. visier_platform_sdk/models/query_dimension_member_selection_dto.py +102 -0
  473. visier_platform_sdk/models/query_execution_error_details_dto.py +94 -0
  474. visier_platform_sdk/models/query_execution_error_dto.py +100 -0
  475. visier_platform_sdk/models/query_execution_errors_dto.py +100 -0
  476. visier_platform_sdk/models/query_execution_options_dto.py +192 -0
  477. visier_platform_sdk/models/query_filter_dto.py +106 -0
  478. visier_platform_sdk/models/query_member_map_property_dto.py +94 -0
  479. visier_platform_sdk/models/query_member_map_selection_dto.py +104 -0
  480. visier_platform_sdk/models/query_numeric_ranges_dto.py +100 -0
  481. visier_platform_sdk/models/query_parameter_value_dto.py +110 -0
  482. visier_platform_sdk/models/query_property_dto.py +120 -0
  483. visier_platform_sdk/models/query_time_interval_dto.py +134 -0
  484. visier_platform_sdk/models/query_time_intervals_dto.py +150 -0
  485. visier_platform_sdk/models/question_categories_api_response_dto.py +96 -0
  486. visier_platform_sdk/models/question_category_api_response_dto.py +90 -0
  487. visier_platform_sdk/models/receiving_job.py +92 -0
  488. visier_platform_sdk/models/receiving_job_and_status_response.py +104 -0
  489. visier_platform_sdk/models/receiving_job_status_response.py +104 -0
  490. visier_platform_sdk/models/redshift_auth_params_dto.py +100 -0
  491. visier_platform_sdk/models/reduced_error_dto.py +88 -0
  492. visier_platform_sdk/models/reduced_tenant_code_error_dto.py +96 -0
  493. visier_platform_sdk/models/reduced_user_id_error_dto.py +94 -0
  494. visier_platform_sdk/models/related_analytic_object_dto.py +90 -0
  495. visier_platform_sdk/models/report_create_request_dto.py +90 -0
  496. visier_platform_sdk/models/report_delete_success_dto.py +88 -0
  497. visier_platform_sdk/models/report_dto.py +115 -0
  498. visier_platform_sdk/models/report_list_response_dto.py +96 -0
  499. visier_platform_sdk/models/result.py +96 -0
  500. visier_platform_sdk/models/role_modules_config_dto.py +88 -0
  501. visier_platform_sdk/models/salary_benchmark_input.py +100 -0
  502. visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +96 -0
  503. visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +106 -0
  504. visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +110 -0
  505. visier_platform_sdk/models/salesforce_auth_params_dto.py +90 -0
  506. visier_platform_sdk/models/salesforce_v2_auth_params_dto.py +94 -0
  507. visier_platform_sdk/models/sample_question_api_response_dto.py +100 -0
  508. visier_platform_sdk/models/sample_questions_api_response_dto.py +96 -0
  509. visier_platform_sdk/models/scenario_info_dto.py +92 -0
  510. visier_platform_sdk/models/scenario_or_snapshot_dto.py +90 -0
  511. visier_platform_sdk/models/securable_dimension_dto.py +102 -0
  512. visier_platform_sdk/models/securable_property_dto.py +96 -0
  513. visier_platform_sdk/models/security_assignment_response_dto.py +96 -0
  514. visier_platform_sdk/models/selection_concept_configuration_dto.py +96 -0
  515. visier_platform_sdk/models/selection_concept_configuration_map_dto.py +96 -0
  516. visier_platform_sdk/models/selection_concept_dto.py +106 -0
  517. visier_platform_sdk/models/selection_concept_list_dto.py +96 -0
  518. visier_platform_sdk/models/selection_concept_reference_dto.py +90 -0
  519. visier_platform_sdk/models/selection_concepts_dto.py +96 -0
  520. visier_platform_sdk/models/service_now_auth_params_dto.py +92 -0
  521. visier_platform_sdk/models/service_now_v2_auth_params_dto.py +96 -0
  522. visier_platform_sdk/models/servicing_capability_proto_enum_access_lookup_dto.py +96 -0
  523. visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +92 -0
  524. visier_platform_sdk/models/set_connector_setting_request_dto.py +98 -0
  525. visier_platform_sdk/models/set_connector_setting_response_dto.py +112 -0
  526. visier_platform_sdk/models/set_connector_settings_request_dto.py +96 -0
  527. visier_platform_sdk/models/set_connector_settings_response_dto.py +96 -0
  528. visier_platform_sdk/models/shareable_data_access_set.py +88 -0
  529. visier_platform_sdk/models/simple_document_header_search_response_dto.py +96 -0
  530. visier_platform_sdk/models/simple_document_header_search_result_dto.py +98 -0
  531. visier_platform_sdk/models/simple_property_type_dto.py +88 -0
  532. visier_platform_sdk/models/simple_user_dto.py +90 -0
  533. visier_platform_sdk/models/skill.py +106 -0
  534. visier_platform_sdk/models/skill_category.py +102 -0
  535. visier_platform_sdk/models/skill_category_entry.py +92 -0
  536. visier_platform_sdk/models/skill_entry.py +92 -0
  537. visier_platform_sdk/models/skill_extraction_input.py +93 -0
  538. visier_platform_sdk/models/skill_group.py +104 -0
  539. visier_platform_sdk/models/skill_group_entry.py +92 -0
  540. visier_platform_sdk/models/skill_match_input.py +91 -0
  541. visier_platform_sdk/models/slack_auth_params_dto.py +92 -0
  542. visier_platform_sdk/models/snapshot_query_execution_dto.py +144 -0
  543. visier_platform_sdk/models/snapshot_query_execution_options_dto.py +134 -0
  544. visier_platform_sdk/models/snowflake_auth_params_dto.py +100 -0
  545. visier_platform_sdk/models/sort_option_dto.py +100 -0
  546. visier_platform_sdk/models/source.py +98 -0
  547. visier_platform_sdk/models/source_import_result_summary_dto.py +94 -0
  548. visier_platform_sdk/models/sources_api_operation_request_dto.py +104 -0
  549. visier_platform_sdk/models/sources_api_put_response_dto.py +92 -0
  550. visier_platform_sdk/models/sql_like200_response.py +138 -0
  551. visier_platform_sdk/models/sql_like_query_execution_dto.py +94 -0
  552. visier_platform_sdk/models/sql_server_auth_params_dto.py +96 -0
  553. visier_platform_sdk/models/start_extraction_response.py +88 -0
  554. visier_platform_sdk/models/start_transfer_response.py +88 -0
  555. visier_platform_sdk/models/static_dimension_filter_dto.py +112 -0
  556. visier_platform_sdk/models/status.py +96 -0
  557. visier_platform_sdk/models/subject_missing_access_dto.py +102 -0
  558. visier_platform_sdk/models/success_factors_auth_params_dto.py +100 -0
  559. visier_platform_sdk/models/success_factors_o_auth_params_dto.py +92 -0
  560. visier_platform_sdk/models/successful_accessible_tenant_profile_assignment_dto.py +92 -0
  561. visier_platform_sdk/models/successful_change_dto.py +98 -0
  562. visier_platform_sdk/models/successful_local_tenant_profile_assignment_dto.py +88 -0
  563. visier_platform_sdk/models/synonym_list_dto.py +88 -0
  564. visier_platform_sdk/models/system_status_dto.py +88 -0
  565. visier_platform_sdk/models/table_response_dto.py +90 -0
  566. visier_platform_sdk/models/tag_map_element_dto.py +90 -0
  567. visier_platform_sdk/models/tag_reference_dto.py +88 -0
  568. visier_platform_sdk/models/tag_reference_list_dto.py +96 -0
  569. visier_platform_sdk/models/tags_dto.py +88 -0
  570. visier_platform_sdk/models/target_project_for_tenant_dto.py +90 -0
  571. visier_platform_sdk/models/target_project_for_tenants_list_dto.py +96 -0
  572. visier_platform_sdk/models/target_tenant_code_dto.py +90 -0
  573. visier_platform_sdk/models/tenant.py +100 -0
  574. visier_platform_sdk/models/tenant_and_credential.py +90 -0
  575. visier_platform_sdk/models/tenant_assignments_dto.py +114 -0
  576. visier_platform_sdk/models/tenant_code_body.py +88 -0
  577. visier_platform_sdk/models/tenant_code_error_dto.py +96 -0
  578. visier_platform_sdk/models/tenant_connector_settings_request_dto.py +98 -0
  579. visier_platform_sdk/models/tenant_data_upload_status_response_dto.py +98 -0
  580. visier_platform_sdk/models/tenant_data_upload_update_status_response_dto.py +94 -0
  581. visier_platform_sdk/models/tenant_data_uploads_list_response_dto.py +100 -0
  582. visier_platform_sdk/models/tenant_data_uploads_response_dto.py +98 -0
  583. visier_platform_sdk/models/tenant_data_uploads_update_response_dto.py +100 -0
  584. visier_platform_sdk/models/tenant_detail_apidto.py +130 -0
  585. visier_platform_sdk/models/tenant_details_traits_dto.py +112 -0
  586. visier_platform_sdk/models/tenant_encryption_key_details_dto.py +96 -0
  587. visier_platform_sdk/models/tenant_encryption_key_dto.py +94 -0
  588. visier_platform_sdk/models/tenant_management_api_get_response_dto.py +156 -0
  589. visier_platform_sdk/models/tenant_management_api_list_response_dto.py +100 -0
  590. visier_platform_sdk/models/tenant_management_api_update_request_dto.py +156 -0
  591. visier_platform_sdk/models/tenant_management_api_update_response_dto.py +136 -0
  592. visier_platform_sdk/models/tenant_module_dto.py +96 -0
  593. visier_platform_sdk/models/tenant_preview_entries_summary_dto.py +102 -0
  594. visier_platform_sdk/models/tenant_preview_entries_summary_list_dto.py +100 -0
  595. visier_platform_sdk/models/tenant_provision_apidto.py +110 -0
  596. visier_platform_sdk/models/tenant_status_apidto.py +94 -0
  597. visier_platform_sdk/models/time_shift_dto.py +112 -0
  598. visier_platform_sdk/models/token_response.py +96 -0
  599. visier_platform_sdk/models/ultimate_auth_params_dto.py +96 -0
  600. visier_platform_sdk/models/update_tenant_model.py +98 -0
  601. visier_platform_sdk/models/upload_to_exclude.py +102 -0
  602. visier_platform_sdk/models/upload_to_include.py +102 -0
  603. visier_platform_sdk/models/user_creation_api_request_dto.py +96 -0
  604. visier_platform_sdk/models/user_creation_api_response_dto.py +98 -0
  605. visier_platform_sdk/models/user_get_api_response_dto.py +122 -0
  606. visier_platform_sdk/models/user_group_assigned_for_local_tenant_dto.py +90 -0
  607. visier_platform_sdk/models/user_group_assignment_dto.py +88 -0
  608. visier_platform_sdk/models/user_group_change_definition_dto.py +108 -0
  609. visier_platform_sdk/models/user_group_change_dimension_filter_dto.py +104 -0
  610. visier_platform_sdk/models/user_group_change_failure_dto.py +96 -0
  611. visier_platform_sdk/models/user_group_change_filter_dto.py +100 -0
  612. visier_platform_sdk/models/user_group_change_member_selection_dto.py +90 -0
  613. visier_platform_sdk/models/user_group_change_response_dto.py +106 -0
  614. visier_platform_sdk/models/user_group_change_success_dto.py +94 -0
  615. visier_platform_sdk/models/user_group_change_users_dto.py +105 -0
  616. visier_platform_sdk/models/user_group_delete_dto.py +92 -0
  617. visier_platform_sdk/models/user_group_delete_failure_dto.py +96 -0
  618. visier_platform_sdk/models/user_group_delete_response_dto.py +106 -0
  619. visier_platform_sdk/models/user_group_delete_success_dto.py +92 -0
  620. visier_platform_sdk/models/user_group_filters_dto.py +96 -0
  621. visier_platform_sdk/models/user_group_get_api_response_dto.py +100 -0
  622. visier_platform_sdk/models/user_group_single_delete_response_dto.py +98 -0
  623. visier_platform_sdk/models/user_groups_change_dto.py +96 -0
  624. visier_platform_sdk/models/user_groups_delete_request_dto.py +96 -0
  625. visier_platform_sdk/models/user_groups_get_api_response_dto.py +100 -0
  626. visier_platform_sdk/models/user_groups_users_dto.py +100 -0
  627. visier_platform_sdk/models/user_groups_users_for_tenant_dto.py +98 -0
  628. visier_platform_sdk/models/user_id_error_dto.py +94 -0
  629. visier_platform_sdk/models/user_property_dto.py +88 -0
  630. visier_platform_sdk/models/user_security_assignments_dto.py +100 -0
  631. visier_platform_sdk/models/user_update_api_request_dto.py +96 -0
  632. visier_platform_sdk/models/users_api_error_message_dto.py +90 -0
  633. visier_platform_sdk/models/users_api_failure_dto.py +98 -0
  634. visier_platform_sdk/models/users_api_response_dto.py +106 -0
  635. visier_platform_sdk/models/users_api_success_dto.py +98 -0
  636. visier_platform_sdk/models/users_creation_api_request_dto.py +96 -0
  637. visier_platform_sdk/models/users_delete_api_request_dto.py +88 -0
  638. visier_platform_sdk/models/users_to_user_group_request_dto.py +90 -0
  639. visier_platform_sdk/models/users_to_user_groups_request_dto.py +102 -0
  640. visier_platform_sdk/models/users_update_api_request_dto.py +96 -0
  641. visier_platform_sdk/models/users_update_api_user_dto.py +98 -0
  642. visier_platform_sdk/models/v2_calculated_property_type_dto.py +92 -0
  643. visier_platform_sdk/models/v2_dimension_dto.py +118 -0
  644. visier_platform_sdk/models/v2_level_dto.py +102 -0
  645. visier_platform_sdk/models/v2_simple_property_type_dto.py +90 -0
  646. visier_platform_sdk/models/validity_range_dto.py +90 -0
  647. visier_platform_sdk/models/vee_clarification_dto.py +98 -0
  648. visier_platform_sdk/models/vee_conversation_dto.py +92 -0
  649. visier_platform_sdk/models/vee_conversation_state_dto.py +88 -0
  650. visier_platform_sdk/models/vee_corrections_dto.py +109 -0
  651. visier_platform_sdk/models/vee_data_dto.py +90 -0
  652. visier_platform_sdk/models/vee_feedback_dto.py +96 -0
  653. visier_platform_sdk/models/vee_options_dto.py +110 -0
  654. visier_platform_sdk/models/vee_question_change_definition_dto.py +100 -0
  655. visier_platform_sdk/models/vee_question_change_definitions_by_tenant_dto.py +100 -0
  656. visier_platform_sdk/models/vee_question_change_failure_dto.py +106 -0
  657. visier_platform_sdk/models/vee_question_change_success_dto.py +104 -0
  658. visier_platform_sdk/models/vee_question_delete_definitions_by_tenant_dto.py +92 -0
  659. visier_platform_sdk/models/vee_question_dto.py +102 -0
  660. visier_platform_sdk/models/vee_questions_bulk_change_response_dto.py +106 -0
  661. visier_platform_sdk/models/vee_questions_change_definitions_dto.py +96 -0
  662. visier_platform_sdk/models/vee_questions_delete_definitions_dto.py +96 -0
  663. visier_platform_sdk/models/vee_response_dto.py +132 -0
  664. visier_platform_sdk/models/vee_response_schema_dto.py +107 -0
  665. visier_platform_sdk/models/vee_response_schema_reference_dto.py +90 -0
  666. visier_platform_sdk/models/vee_sample_question_dto.py +94 -0
  667. visier_platform_sdk/models/vee_sample_question_library_dto.py +96 -0
  668. visier_platform_sdk/models/vee_status_code_dto.py +100 -0
  669. visier_platform_sdk/models/vee_status_dto.py +88 -0
  670. visier_platform_sdk/models/vee_visual_dto.py +92 -0
  671. visier_platform_sdk/models/vee_visual_options_dto.py +90 -0
  672. visier_platform_sdk/models/version_information_dto.py +102 -0
  673. visier_platform_sdk/models/webhook_basic_auth_credential_dto.py +90 -0
  674. visier_platform_sdk/models/webhook_credentials_dto.py +94 -0
  675. visier_platform_sdk/models/webhook_details_dto.py +104 -0
  676. visier_platform_sdk/models/webhook_dto.py +96 -0
  677. visier_platform_sdk/models/webhook_event_type_dto.py +88 -0
  678. visier_platform_sdk/models/webhook_message_response_dto.py +94 -0
  679. visier_platform_sdk/models/webhook_request_dto.py +98 -0
  680. visier_platform_sdk/models/webhooks_dto.py +96 -0
  681. visier_platform_sdk/models/willow_auth_params_dto.py +90 -0
  682. visier_platform_sdk/models/workday_auth_params_dto.py +118 -0
  683. visier_platform_sdk/models/workday_o_auth_params_dto.py +92 -0
  684. visier_platform_sdk/models/workday_raas_auth_params_dto.py +96 -0
  685. visier_platform_sdk/models/workday_refresh_token_params_dto.py +92 -0
  686. visier_platform_sdk/models/zoom_auth_params_dto.py +92 -0
  687. visier_platform_sdk/py.typed +0 -0
  688. visier_platform_sdk/rest.py +259 -0
  689. visier_platform_sdk-22222222.99200.21494.dist-info/METADATA +28 -0
  690. visier_platform_sdk-22222222.99200.21494.dist-info/RECORD +692 -0
  691. visier_platform_sdk-22222222.99200.21494.dist-info/WHEEL +5 -0
  692. visier_platform_sdk-22222222.99200.21494.dist-info/top_level.txt +1 -0
@@ -0,0 +1,4295 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ API Reference
5
+
6
+ Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
7
+
8
+ The version of the OpenAPI document: 22222222.99200.21494
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 List, Optional
22
+ from typing_extensions import Annotated
23
+ from visier_platform_sdk.models.bulk_data_access_set_response_dto import BulkDataAccessSetResponseDTO
24
+ from visier_platform_sdk.models.capability_dto import CapabilityDTO
25
+ from visier_platform_sdk.models.content_package_dto import ContentPackageDTO
26
+ from visier_platform_sdk.models.create_data_access_set_request_dto import CreateDataAccessSetRequestDTO
27
+ from visier_platform_sdk.models.data_access_set_dto import DataAccessSetDTO
28
+ from visier_platform_sdk.models.delete_permissions_request_dto import DeletePermissionsRequestDTO
29
+ from visier_platform_sdk.models.get_capabilities_api_response_dto import GetCapabilitiesAPIResponseDTO
30
+ from visier_platform_sdk.models.get_content_packages_api_response_dto import GetContentPackagesAPIResponseDTO
31
+ from visier_platform_sdk.models.get_data_access_sets_api_response_dto import GetDataAccessSetsAPIResponseDTO
32
+ from visier_platform_sdk.models.get_data_security_objects_api_response_dto import GetDataSecurityObjectsAPIResponseDTO
33
+ from visier_platform_sdk.models.get_permissions_api_response_dto import GetPermissionsAPIResponseDTO
34
+ from visier_platform_sdk.models.permission_bulk_operation_response_dto import PermissionBulkOperationResponseDTO
35
+ from visier_platform_sdk.models.permission_dto import PermissionDTO
36
+ from visier_platform_sdk.models.permissions_list_dto import PermissionsListDTO
37
+
38
+ from visier_platform_sdk.api_client import ApiClient, RequestSerialized
39
+ from visier_platform_sdk.api_response import ApiResponse
40
+ from visier_platform_sdk.rest import RESTResponseType
41
+
42
+
43
+ class PermissionsApi:
44
+ """NOTE: This class is auto generated by OpenAPI Generator
45
+ Ref: https://openapi-generator.tech
46
+
47
+ Do not edit the class manually.
48
+ """
49
+
50
+ def __init__(self, api_client=None) -> None:
51
+ if api_client is None:
52
+ api_client = ApiClient.get_default()
53
+ self.api_client = api_client
54
+
55
+
56
+ @validate_call
57
+ def create_data_access_sets(
58
+ self,
59
+ create_data_access_set_request_dto: CreateDataAccessSetRequestDTO,
60
+ 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,
61
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
62
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
63
+ _request_timeout: Union[
64
+ None,
65
+ Annotated[StrictFloat, Field(gt=0)],
66
+ Tuple[
67
+ Annotated[StrictFloat, Field(gt=0)],
68
+ Annotated[StrictFloat, Field(gt=0)]
69
+ ]
70
+ ] = None,
71
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
72
+ _content_type: Optional[StrictStr] = None,
73
+ _headers: Optional[Dict[StrictStr, Any]] = None,
74
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
75
+ ) -> BulkDataAccessSetResponseDTO:
76
+ """Create shareable data access sets
77
+
78
+ Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header.
79
+
80
+ :param create_data_access_set_request_dto: (required)
81
+ :type create_data_access_set_request_dto: CreateDataAccessSetRequestDTO
82
+ :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.
83
+ :type target_tenant_id: str
84
+ :param project_id: Optionally, specify a project in which to make the request.
85
+ :type project_id: str
86
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
87
+ :type non_versioned: bool
88
+ :param _request_timeout: timeout setting for this request. If one
89
+ number provided, it will be total request
90
+ timeout. It can also be a pair (tuple) of
91
+ (connection, read) timeouts.
92
+ :type _request_timeout: int, tuple(int, int), optional
93
+ :param _request_auth: set to override the auth_settings for an a single
94
+ request; this effectively ignores the
95
+ authentication in the spec for a single request.
96
+ :type _request_auth: dict, optional
97
+ :param _content_type: force content-type for the request.
98
+ :type _content_type: str, Optional
99
+ :param _headers: set to override the headers for a single
100
+ request; this effectively ignores the headers
101
+ in the spec for a single request.
102
+ :type _headers: dict, optional
103
+ :param _host_index: set to override the host_index for a single
104
+ request; this effectively ignores the host_index
105
+ in the spec for a single request.
106
+ :type _host_index: int, optional
107
+ :return: Returns the result object.
108
+ """ # noqa: E501
109
+
110
+ _param = self._create_data_access_sets_serialize(
111
+ create_data_access_set_request_dto=create_data_access_set_request_dto,
112
+ target_tenant_id=target_tenant_id,
113
+ project_id=project_id,
114
+ non_versioned=non_versioned,
115
+ _request_auth=_request_auth,
116
+ _content_type=_content_type,
117
+ _headers=_headers,
118
+ _host_index=_host_index
119
+ )
120
+
121
+ _response_types_map: Dict[str, Optional[str]] = {
122
+ '200': "BulkDataAccessSetResponseDTO",
123
+ }
124
+ response_data = self.api_client.call_api(
125
+ *_param,
126
+ _request_timeout=_request_timeout
127
+ )
128
+ response_data.read()
129
+ return self.api_client.response_deserialize(
130
+ response_data=response_data,
131
+ response_types_map=_response_types_map,
132
+ ).data
133
+
134
+
135
+ @validate_call
136
+ def create_data_access_sets_with_http_info(
137
+ self,
138
+ create_data_access_set_request_dto: CreateDataAccessSetRequestDTO,
139
+ 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,
140
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
141
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
142
+ _request_timeout: Union[
143
+ None,
144
+ Annotated[StrictFloat, Field(gt=0)],
145
+ Tuple[
146
+ Annotated[StrictFloat, Field(gt=0)],
147
+ Annotated[StrictFloat, Field(gt=0)]
148
+ ]
149
+ ] = None,
150
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
151
+ _content_type: Optional[StrictStr] = None,
152
+ _headers: Optional[Dict[StrictStr, Any]] = None,
153
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
154
+ ) -> ApiResponse[BulkDataAccessSetResponseDTO]:
155
+ """Create shareable data access sets
156
+
157
+ Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header.
158
+
159
+ :param create_data_access_set_request_dto: (required)
160
+ :type create_data_access_set_request_dto: CreateDataAccessSetRequestDTO
161
+ :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.
162
+ :type target_tenant_id: str
163
+ :param project_id: Optionally, specify a project in which to make the request.
164
+ :type project_id: str
165
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
166
+ :type non_versioned: bool
167
+ :param _request_timeout: timeout setting for this request. If one
168
+ number provided, it will be total request
169
+ timeout. It can also be a pair (tuple) of
170
+ (connection, read) timeouts.
171
+ :type _request_timeout: int, tuple(int, int), optional
172
+ :param _request_auth: set to override the auth_settings for an a single
173
+ request; this effectively ignores the
174
+ authentication in the spec for a single request.
175
+ :type _request_auth: dict, optional
176
+ :param _content_type: force content-type for the request.
177
+ :type _content_type: str, Optional
178
+ :param _headers: set to override the headers for a single
179
+ request; this effectively ignores the headers
180
+ in the spec for a single request.
181
+ :type _headers: dict, optional
182
+ :param _host_index: set to override the host_index for a single
183
+ request; this effectively ignores the host_index
184
+ in the spec for a single request.
185
+ :type _host_index: int, optional
186
+ :return: Returns the result object.
187
+ """ # noqa: E501
188
+
189
+ _param = self._create_data_access_sets_serialize(
190
+ create_data_access_set_request_dto=create_data_access_set_request_dto,
191
+ target_tenant_id=target_tenant_id,
192
+ project_id=project_id,
193
+ non_versioned=non_versioned,
194
+ _request_auth=_request_auth,
195
+ _content_type=_content_type,
196
+ _headers=_headers,
197
+ _host_index=_host_index
198
+ )
199
+
200
+ _response_types_map: Dict[str, Optional[str]] = {
201
+ '200': "BulkDataAccessSetResponseDTO",
202
+ }
203
+ response_data = self.api_client.call_api(
204
+ *_param,
205
+ _request_timeout=_request_timeout
206
+ )
207
+ response_data.read()
208
+ return self.api_client.response_deserialize(
209
+ response_data=response_data,
210
+ response_types_map=_response_types_map,
211
+ )
212
+
213
+
214
+ @validate_call
215
+ def create_data_access_sets_without_preload_content(
216
+ self,
217
+ create_data_access_set_request_dto: CreateDataAccessSetRequestDTO,
218
+ 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,
219
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
220
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
221
+ _request_timeout: Union[
222
+ None,
223
+ Annotated[StrictFloat, Field(gt=0)],
224
+ Tuple[
225
+ Annotated[StrictFloat, Field(gt=0)],
226
+ Annotated[StrictFloat, Field(gt=0)]
227
+ ]
228
+ ] = None,
229
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
230
+ _content_type: Optional[StrictStr] = None,
231
+ _headers: Optional[Dict[StrictStr, Any]] = None,
232
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
233
+ ) -> RESTResponseType:
234
+ """Create shareable data access sets
235
+
236
+ Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header.
237
+
238
+ :param create_data_access_set_request_dto: (required)
239
+ :type create_data_access_set_request_dto: CreateDataAccessSetRequestDTO
240
+ :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.
241
+ :type target_tenant_id: str
242
+ :param project_id: Optionally, specify a project in which to make the request.
243
+ :type project_id: str
244
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
245
+ :type non_versioned: bool
246
+ :param _request_timeout: timeout setting for this request. If one
247
+ number provided, it will be total request
248
+ timeout. It can also be a pair (tuple) of
249
+ (connection, read) timeouts.
250
+ :type _request_timeout: int, tuple(int, int), optional
251
+ :param _request_auth: set to override the auth_settings for an a single
252
+ request; this effectively ignores the
253
+ authentication in the spec for a single request.
254
+ :type _request_auth: dict, optional
255
+ :param _content_type: force content-type for the request.
256
+ :type _content_type: str, Optional
257
+ :param _headers: set to override the headers for a single
258
+ request; this effectively ignores the headers
259
+ in the spec for a single request.
260
+ :type _headers: dict, optional
261
+ :param _host_index: set to override the host_index for a single
262
+ request; this effectively ignores the host_index
263
+ in the spec for a single request.
264
+ :type _host_index: int, optional
265
+ :return: Returns the result object.
266
+ """ # noqa: E501
267
+
268
+ _param = self._create_data_access_sets_serialize(
269
+ create_data_access_set_request_dto=create_data_access_set_request_dto,
270
+ target_tenant_id=target_tenant_id,
271
+ project_id=project_id,
272
+ non_versioned=non_versioned,
273
+ _request_auth=_request_auth,
274
+ _content_type=_content_type,
275
+ _headers=_headers,
276
+ _host_index=_host_index
277
+ )
278
+
279
+ _response_types_map: Dict[str, Optional[str]] = {
280
+ '200': "BulkDataAccessSetResponseDTO",
281
+ }
282
+ response_data = self.api_client.call_api(
283
+ *_param,
284
+ _request_timeout=_request_timeout
285
+ )
286
+ return response_data.response
287
+
288
+
289
+ def _create_data_access_sets_serialize(
290
+ self,
291
+ create_data_access_set_request_dto,
292
+ target_tenant_id,
293
+ project_id,
294
+ non_versioned,
295
+ _request_auth,
296
+ _content_type,
297
+ _headers,
298
+ _host_index,
299
+ ) -> RequestSerialized:
300
+
301
+ _host = None
302
+
303
+ _collection_formats: Dict[str, str] = {
304
+ }
305
+
306
+ _path_params: Dict[str, str] = {}
307
+ _query_params: List[Tuple[str, str]] = []
308
+ _header_params: Dict[str, Optional[str]] = _headers or {}
309
+ _form_params: List[Tuple[str, str]] = []
310
+ _files: Dict[
311
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
312
+ ] = {}
313
+ _body_params: Optional[bytes] = None
314
+
315
+ # process the path parameters
316
+ # process the query parameters
317
+ # process the header parameters
318
+ if target_tenant_id is not None:
319
+ _header_params['TargetTenantID'] = target_tenant_id
320
+ if project_id is not None:
321
+ _header_params['ProjectID'] = project_id
322
+ if non_versioned is not None:
323
+ _header_params['NonVersioned'] = non_versioned
324
+ # process the form parameters
325
+ # process the body parameter
326
+ if create_data_access_set_request_dto is not None:
327
+ _body_params = create_data_access_set_request_dto
328
+
329
+
330
+ # set the HTTP header `Accept`
331
+ if 'Accept' not in _header_params:
332
+ _header_params['Accept'] = self.api_client.select_header_accept(
333
+ [
334
+ 'application/json'
335
+ ]
336
+ )
337
+
338
+ # set the HTTP header `Content-Type`
339
+ if _content_type:
340
+ _header_params['Content-Type'] = _content_type
341
+ else:
342
+ _default_content_type = (
343
+ self.api_client.select_header_content_type(
344
+ [
345
+ 'application/json'
346
+ ]
347
+ )
348
+ )
349
+ if _default_content_type is not None:
350
+ _header_params['Content-Type'] = _default_content_type
351
+
352
+ # authentication setting
353
+ _auth_settings: List[str] = [
354
+ 'CookieAuth',
355
+ 'ApiKeyAuth',
356
+ 'OAuth2Auth',
357
+ 'OAuth2Auth',
358
+ 'BearerAuth'
359
+ ]
360
+
361
+ return self.api_client.param_serialize(
362
+ method='POST',
363
+ resource_path='/v1/admin/data-access-sets',
364
+ path_params=_path_params,
365
+ query_params=_query_params,
366
+ header_params=_header_params,
367
+ body=_body_params,
368
+ post_params=_form_params,
369
+ files=_files,
370
+ auth_settings=_auth_settings,
371
+ collection_formats=_collection_formats,
372
+ _host=_host,
373
+ _request_auth=_request_auth
374
+ )
375
+
376
+
377
+
378
+
379
+ @validate_call
380
+ def create_permissions(
381
+ self,
382
+ permissions_list_dto: PermissionsListDTO,
383
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None,
384
+ 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,
385
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
386
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
387
+ _request_timeout: Union[
388
+ None,
389
+ Annotated[StrictFloat, Field(gt=0)],
390
+ Tuple[
391
+ Annotated[StrictFloat, Field(gt=0)],
392
+ Annotated[StrictFloat, Field(gt=0)]
393
+ ]
394
+ ] = None,
395
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
396
+ _content_type: Optional[StrictStr] = None,
397
+ _headers: Optional[Dict[StrictStr, Any]] = None,
398
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
399
+ ) -> PermissionBulkOperationResponseDTO:
400
+ """Create permissions
401
+
402
+ Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header.
403
+
404
+ :param permissions_list_dto: (required)
405
+ :type permissions_list_dto: PermissionsListDTO
406
+ :param tenant_code: Specify the tenant to create permissions in.
407
+ :type tenant_code: str
408
+ :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.
409
+ :type target_tenant_id: str
410
+ :param project_id: Optionally, specify a project in which to make the request.
411
+ :type project_id: str
412
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
413
+ :type non_versioned: bool
414
+ :param _request_timeout: timeout setting for this request. If one
415
+ number provided, it will be total request
416
+ timeout. It can also be a pair (tuple) of
417
+ (connection, read) timeouts.
418
+ :type _request_timeout: int, tuple(int, int), optional
419
+ :param _request_auth: set to override the auth_settings for an a single
420
+ request; this effectively ignores the
421
+ authentication in the spec for a single request.
422
+ :type _request_auth: dict, optional
423
+ :param _content_type: force content-type for the request.
424
+ :type _content_type: str, Optional
425
+ :param _headers: set to override the headers for a single
426
+ request; this effectively ignores the headers
427
+ in the spec for a single request.
428
+ :type _headers: dict, optional
429
+ :param _host_index: set to override the host_index for a single
430
+ request; this effectively ignores the host_index
431
+ in the spec for a single request.
432
+ :type _host_index: int, optional
433
+ :return: Returns the result object.
434
+ """ # noqa: E501
435
+
436
+ _param = self._create_permissions_serialize(
437
+ permissions_list_dto=permissions_list_dto,
438
+ tenant_code=tenant_code,
439
+ target_tenant_id=target_tenant_id,
440
+ project_id=project_id,
441
+ non_versioned=non_versioned,
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': "PermissionBulkOperationResponseDTO",
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
+ ).data
460
+
461
+
462
+ @validate_call
463
+ def create_permissions_with_http_info(
464
+ self,
465
+ permissions_list_dto: PermissionsListDTO,
466
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None,
467
+ 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,
468
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
469
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
470
+ _request_timeout: Union[
471
+ None,
472
+ Annotated[StrictFloat, Field(gt=0)],
473
+ Tuple[
474
+ Annotated[StrictFloat, Field(gt=0)],
475
+ Annotated[StrictFloat, Field(gt=0)]
476
+ ]
477
+ ] = None,
478
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
479
+ _content_type: Optional[StrictStr] = None,
480
+ _headers: Optional[Dict[StrictStr, Any]] = None,
481
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
482
+ ) -> ApiResponse[PermissionBulkOperationResponseDTO]:
483
+ """Create permissions
484
+
485
+ Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header.
486
+
487
+ :param permissions_list_dto: (required)
488
+ :type permissions_list_dto: PermissionsListDTO
489
+ :param tenant_code: Specify the tenant to create permissions in.
490
+ :type tenant_code: str
491
+ :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.
492
+ :type target_tenant_id: str
493
+ :param project_id: Optionally, specify a project in which to make the request.
494
+ :type project_id: str
495
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
496
+ :type non_versioned: bool
497
+ :param _request_timeout: timeout setting for this request. If one
498
+ number provided, it will be total request
499
+ timeout. It can also be a pair (tuple) of
500
+ (connection, read) timeouts.
501
+ :type _request_timeout: int, tuple(int, int), optional
502
+ :param _request_auth: set to override the auth_settings for an a single
503
+ request; this effectively ignores the
504
+ authentication in the spec for a single request.
505
+ :type _request_auth: dict, optional
506
+ :param _content_type: force content-type for the request.
507
+ :type _content_type: str, Optional
508
+ :param _headers: set to override the headers for a single
509
+ request; this effectively ignores the headers
510
+ in the spec for a single request.
511
+ :type _headers: dict, optional
512
+ :param _host_index: set to override the host_index for a single
513
+ request; this effectively ignores the host_index
514
+ in the spec for a single request.
515
+ :type _host_index: int, optional
516
+ :return: Returns the result object.
517
+ """ # noqa: E501
518
+
519
+ _param = self._create_permissions_serialize(
520
+ permissions_list_dto=permissions_list_dto,
521
+ tenant_code=tenant_code,
522
+ target_tenant_id=target_tenant_id,
523
+ project_id=project_id,
524
+ non_versioned=non_versioned,
525
+ _request_auth=_request_auth,
526
+ _content_type=_content_type,
527
+ _headers=_headers,
528
+ _host_index=_host_index
529
+ )
530
+
531
+ _response_types_map: Dict[str, Optional[str]] = {
532
+ '200': "PermissionBulkOperationResponseDTO",
533
+ }
534
+ response_data = self.api_client.call_api(
535
+ *_param,
536
+ _request_timeout=_request_timeout
537
+ )
538
+ response_data.read()
539
+ return self.api_client.response_deserialize(
540
+ response_data=response_data,
541
+ response_types_map=_response_types_map,
542
+ )
543
+
544
+
545
+ @validate_call
546
+ def create_permissions_without_preload_content(
547
+ self,
548
+ permissions_list_dto: PermissionsListDTO,
549
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None,
550
+ 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,
551
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
552
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
553
+ _request_timeout: Union[
554
+ None,
555
+ Annotated[StrictFloat, Field(gt=0)],
556
+ Tuple[
557
+ Annotated[StrictFloat, Field(gt=0)],
558
+ Annotated[StrictFloat, Field(gt=0)]
559
+ ]
560
+ ] = None,
561
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
562
+ _content_type: Optional[StrictStr] = None,
563
+ _headers: Optional[Dict[StrictStr, Any]] = None,
564
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
565
+ ) -> RESTResponseType:
566
+ """Create permissions
567
+
568
+ Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header.
569
+
570
+ :param permissions_list_dto: (required)
571
+ :type permissions_list_dto: PermissionsListDTO
572
+ :param tenant_code: Specify the tenant to create permissions in.
573
+ :type tenant_code: str
574
+ :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.
575
+ :type target_tenant_id: str
576
+ :param project_id: Optionally, specify a project in which to make the request.
577
+ :type project_id: str
578
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
579
+ :type non_versioned: bool
580
+ :param _request_timeout: timeout setting for this request. If one
581
+ number provided, it will be total request
582
+ timeout. It can also be a pair (tuple) of
583
+ (connection, read) timeouts.
584
+ :type _request_timeout: int, tuple(int, int), optional
585
+ :param _request_auth: set to override the auth_settings for an a single
586
+ request; this effectively ignores the
587
+ authentication in the spec for a single request.
588
+ :type _request_auth: dict, optional
589
+ :param _content_type: force content-type for the request.
590
+ :type _content_type: str, Optional
591
+ :param _headers: set to override the headers for a single
592
+ request; this effectively ignores the headers
593
+ in the spec for a single request.
594
+ :type _headers: dict, optional
595
+ :param _host_index: set to override the host_index for a single
596
+ request; this effectively ignores the host_index
597
+ in the spec for a single request.
598
+ :type _host_index: int, optional
599
+ :return: Returns the result object.
600
+ """ # noqa: E501
601
+
602
+ _param = self._create_permissions_serialize(
603
+ permissions_list_dto=permissions_list_dto,
604
+ tenant_code=tenant_code,
605
+ target_tenant_id=target_tenant_id,
606
+ project_id=project_id,
607
+ non_versioned=non_versioned,
608
+ _request_auth=_request_auth,
609
+ _content_type=_content_type,
610
+ _headers=_headers,
611
+ _host_index=_host_index
612
+ )
613
+
614
+ _response_types_map: Dict[str, Optional[str]] = {
615
+ '200': "PermissionBulkOperationResponseDTO",
616
+ }
617
+ response_data = self.api_client.call_api(
618
+ *_param,
619
+ _request_timeout=_request_timeout
620
+ )
621
+ return response_data.response
622
+
623
+
624
+ def _create_permissions_serialize(
625
+ self,
626
+ permissions_list_dto,
627
+ tenant_code,
628
+ target_tenant_id,
629
+ project_id,
630
+ non_versioned,
631
+ _request_auth,
632
+ _content_type,
633
+ _headers,
634
+ _host_index,
635
+ ) -> RequestSerialized:
636
+
637
+ _host = None
638
+
639
+ _collection_formats: Dict[str, str] = {
640
+ }
641
+
642
+ _path_params: Dict[str, str] = {}
643
+ _query_params: List[Tuple[str, str]] = []
644
+ _header_params: Dict[str, Optional[str]] = _headers or {}
645
+ _form_params: List[Tuple[str, str]] = []
646
+ _files: Dict[
647
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
648
+ ] = {}
649
+ _body_params: Optional[bytes] = None
650
+
651
+ # process the path parameters
652
+ # process the query parameters
653
+ if tenant_code is not None:
654
+
655
+ _query_params.append(('tenantCode', tenant_code))
656
+
657
+ # process the header parameters
658
+ if target_tenant_id is not None:
659
+ _header_params['TargetTenantID'] = target_tenant_id
660
+ if project_id is not None:
661
+ _header_params['ProjectID'] = project_id
662
+ if non_versioned is not None:
663
+ _header_params['NonVersioned'] = non_versioned
664
+ # process the form parameters
665
+ # process the body parameter
666
+ if permissions_list_dto is not None:
667
+ _body_params = permissions_list_dto
668
+
669
+
670
+ # set the HTTP header `Accept`
671
+ if 'Accept' not in _header_params:
672
+ _header_params['Accept'] = self.api_client.select_header_accept(
673
+ [
674
+ 'application/json'
675
+ ]
676
+ )
677
+
678
+ # set the HTTP header `Content-Type`
679
+ if _content_type:
680
+ _header_params['Content-Type'] = _content_type
681
+ else:
682
+ _default_content_type = (
683
+ self.api_client.select_header_content_type(
684
+ [
685
+ 'application/json'
686
+ ]
687
+ )
688
+ )
689
+ if _default_content_type is not None:
690
+ _header_params['Content-Type'] = _default_content_type
691
+
692
+ # authentication setting
693
+ _auth_settings: List[str] = [
694
+ 'CookieAuth',
695
+ 'ApiKeyAuth',
696
+ 'OAuth2Auth',
697
+ 'OAuth2Auth',
698
+ 'BearerAuth'
699
+ ]
700
+
701
+ return self.api_client.param_serialize(
702
+ method='POST',
703
+ resource_path='/v1/admin/permissions',
704
+ path_params=_path_params,
705
+ query_params=_query_params,
706
+ header_params=_header_params,
707
+ body=_body_params,
708
+ post_params=_form_params,
709
+ files=_files,
710
+ auth_settings=_auth_settings,
711
+ collection_formats=_collection_formats,
712
+ _host=_host,
713
+ _request_auth=_request_auth
714
+ )
715
+
716
+
717
+
718
+
719
+ @validate_call
720
+ def delete_permissions(
721
+ self,
722
+ delete_permissions_request_dto: DeletePermissionsRequestDTO,
723
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None,
724
+ 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,
725
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
726
+ _request_timeout: Union[
727
+ None,
728
+ Annotated[StrictFloat, Field(gt=0)],
729
+ Tuple[
730
+ Annotated[StrictFloat, Field(gt=0)],
731
+ Annotated[StrictFloat, Field(gt=0)]
732
+ ]
733
+ ] = None,
734
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
735
+ _content_type: Optional[StrictStr] = None,
736
+ _headers: Optional[Dict[StrictStr, Any]] = None,
737
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
738
+ ) -> PermissionBulkOperationResponseDTO:
739
+ """Delete permissions
740
+
741
+ Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header.
742
+
743
+ :param delete_permissions_request_dto: (required)
744
+ :type delete_permissions_request_dto: DeletePermissionsRequestDTO
745
+ :param tenant_code: Specify the tenant to delete permissions from.
746
+ :type tenant_code: str
747
+ :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.
748
+ :type target_tenant_id: str
749
+ :param project_id: Optionally, specify a project in which to make the request.
750
+ :type project_id: str
751
+ :param _request_timeout: timeout setting for this request. If one
752
+ number provided, it will be total request
753
+ timeout. It can also be a pair (tuple) of
754
+ (connection, read) timeouts.
755
+ :type _request_timeout: int, tuple(int, int), optional
756
+ :param _request_auth: set to override the auth_settings for an a single
757
+ request; this effectively ignores the
758
+ authentication in the spec for a single request.
759
+ :type _request_auth: dict, optional
760
+ :param _content_type: force content-type for the request.
761
+ :type _content_type: str, Optional
762
+ :param _headers: set to override the headers for a single
763
+ request; this effectively ignores the headers
764
+ in the spec for a single request.
765
+ :type _headers: dict, optional
766
+ :param _host_index: set to override the host_index for a single
767
+ request; this effectively ignores the host_index
768
+ in the spec for a single request.
769
+ :type _host_index: int, optional
770
+ :return: Returns the result object.
771
+ """ # noqa: E501
772
+
773
+ _param = self._delete_permissions_serialize(
774
+ delete_permissions_request_dto=delete_permissions_request_dto,
775
+ tenant_code=tenant_code,
776
+ target_tenant_id=target_tenant_id,
777
+ project_id=project_id,
778
+ _request_auth=_request_auth,
779
+ _content_type=_content_type,
780
+ _headers=_headers,
781
+ _host_index=_host_index
782
+ )
783
+
784
+ _response_types_map: Dict[str, Optional[str]] = {
785
+ '200': "PermissionBulkOperationResponseDTO",
786
+ }
787
+ response_data = self.api_client.call_api(
788
+ *_param,
789
+ _request_timeout=_request_timeout
790
+ )
791
+ response_data.read()
792
+ return self.api_client.response_deserialize(
793
+ response_data=response_data,
794
+ response_types_map=_response_types_map,
795
+ ).data
796
+
797
+
798
+ @validate_call
799
+ def delete_permissions_with_http_info(
800
+ self,
801
+ delete_permissions_request_dto: DeletePermissionsRequestDTO,
802
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None,
803
+ 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,
804
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
805
+ _request_timeout: Union[
806
+ None,
807
+ Annotated[StrictFloat, Field(gt=0)],
808
+ Tuple[
809
+ Annotated[StrictFloat, Field(gt=0)],
810
+ Annotated[StrictFloat, Field(gt=0)]
811
+ ]
812
+ ] = None,
813
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
814
+ _content_type: Optional[StrictStr] = None,
815
+ _headers: Optional[Dict[StrictStr, Any]] = None,
816
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
817
+ ) -> ApiResponse[PermissionBulkOperationResponseDTO]:
818
+ """Delete permissions
819
+
820
+ Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header.
821
+
822
+ :param delete_permissions_request_dto: (required)
823
+ :type delete_permissions_request_dto: DeletePermissionsRequestDTO
824
+ :param tenant_code: Specify the tenant to delete permissions from.
825
+ :type tenant_code: str
826
+ :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.
827
+ :type target_tenant_id: str
828
+ :param project_id: Optionally, specify a project in which to make the request.
829
+ :type project_id: str
830
+ :param _request_timeout: timeout setting for this request. If one
831
+ number provided, it will be total request
832
+ timeout. It can also be a pair (tuple) of
833
+ (connection, read) timeouts.
834
+ :type _request_timeout: int, tuple(int, int), optional
835
+ :param _request_auth: set to override the auth_settings for an a single
836
+ request; this effectively ignores the
837
+ authentication in the spec for a single request.
838
+ :type _request_auth: dict, optional
839
+ :param _content_type: force content-type for the request.
840
+ :type _content_type: str, Optional
841
+ :param _headers: set to override the headers for a single
842
+ request; this effectively ignores the headers
843
+ in the spec for a single request.
844
+ :type _headers: dict, optional
845
+ :param _host_index: set to override the host_index for a single
846
+ request; this effectively ignores the host_index
847
+ in the spec for a single request.
848
+ :type _host_index: int, optional
849
+ :return: Returns the result object.
850
+ """ # noqa: E501
851
+
852
+ _param = self._delete_permissions_serialize(
853
+ delete_permissions_request_dto=delete_permissions_request_dto,
854
+ tenant_code=tenant_code,
855
+ target_tenant_id=target_tenant_id,
856
+ project_id=project_id,
857
+ _request_auth=_request_auth,
858
+ _content_type=_content_type,
859
+ _headers=_headers,
860
+ _host_index=_host_index
861
+ )
862
+
863
+ _response_types_map: Dict[str, Optional[str]] = {
864
+ '200': "PermissionBulkOperationResponseDTO",
865
+ }
866
+ response_data = self.api_client.call_api(
867
+ *_param,
868
+ _request_timeout=_request_timeout
869
+ )
870
+ response_data.read()
871
+ return self.api_client.response_deserialize(
872
+ response_data=response_data,
873
+ response_types_map=_response_types_map,
874
+ )
875
+
876
+
877
+ @validate_call
878
+ def delete_permissions_without_preload_content(
879
+ self,
880
+ delete_permissions_request_dto: DeletePermissionsRequestDTO,
881
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None,
882
+ 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,
883
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
884
+ _request_timeout: Union[
885
+ None,
886
+ Annotated[StrictFloat, Field(gt=0)],
887
+ Tuple[
888
+ Annotated[StrictFloat, Field(gt=0)],
889
+ Annotated[StrictFloat, Field(gt=0)]
890
+ ]
891
+ ] = None,
892
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
893
+ _content_type: Optional[StrictStr] = None,
894
+ _headers: Optional[Dict[StrictStr, Any]] = None,
895
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
896
+ ) -> RESTResponseType:
897
+ """Delete permissions
898
+
899
+ Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header.
900
+
901
+ :param delete_permissions_request_dto: (required)
902
+ :type delete_permissions_request_dto: DeletePermissionsRequestDTO
903
+ :param tenant_code: Specify the tenant to delete permissions from.
904
+ :type tenant_code: str
905
+ :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.
906
+ :type target_tenant_id: str
907
+ :param project_id: Optionally, specify a project in which to make the request.
908
+ :type project_id: str
909
+ :param _request_timeout: timeout setting for this request. If one
910
+ number provided, it will be total request
911
+ timeout. It can also be a pair (tuple) of
912
+ (connection, read) timeouts.
913
+ :type _request_timeout: int, tuple(int, int), optional
914
+ :param _request_auth: set to override the auth_settings for an a single
915
+ request; this effectively ignores the
916
+ authentication in the spec for a single request.
917
+ :type _request_auth: dict, optional
918
+ :param _content_type: force content-type for the request.
919
+ :type _content_type: str, Optional
920
+ :param _headers: set to override the headers for a single
921
+ request; this effectively ignores the headers
922
+ in the spec for a single request.
923
+ :type _headers: dict, optional
924
+ :param _host_index: set to override the host_index for a single
925
+ request; this effectively ignores the host_index
926
+ in the spec for a single request.
927
+ :type _host_index: int, optional
928
+ :return: Returns the result object.
929
+ """ # noqa: E501
930
+
931
+ _param = self._delete_permissions_serialize(
932
+ delete_permissions_request_dto=delete_permissions_request_dto,
933
+ tenant_code=tenant_code,
934
+ target_tenant_id=target_tenant_id,
935
+ project_id=project_id,
936
+ _request_auth=_request_auth,
937
+ _content_type=_content_type,
938
+ _headers=_headers,
939
+ _host_index=_host_index
940
+ )
941
+
942
+ _response_types_map: Dict[str, Optional[str]] = {
943
+ '200': "PermissionBulkOperationResponseDTO",
944
+ }
945
+ response_data = self.api_client.call_api(
946
+ *_param,
947
+ _request_timeout=_request_timeout
948
+ )
949
+ return response_data.response
950
+
951
+
952
+ def _delete_permissions_serialize(
953
+ self,
954
+ delete_permissions_request_dto,
955
+ tenant_code,
956
+ target_tenant_id,
957
+ project_id,
958
+ _request_auth,
959
+ _content_type,
960
+ _headers,
961
+ _host_index,
962
+ ) -> RequestSerialized:
963
+
964
+ _host = None
965
+
966
+ _collection_formats: Dict[str, str] = {
967
+ }
968
+
969
+ _path_params: Dict[str, str] = {}
970
+ _query_params: List[Tuple[str, str]] = []
971
+ _header_params: Dict[str, Optional[str]] = _headers or {}
972
+ _form_params: List[Tuple[str, str]] = []
973
+ _files: Dict[
974
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
975
+ ] = {}
976
+ _body_params: Optional[bytes] = None
977
+
978
+ # process the path parameters
979
+ # process the query parameters
980
+ if tenant_code is not None:
981
+
982
+ _query_params.append(('tenantCode', tenant_code))
983
+
984
+ # process the header parameters
985
+ if target_tenant_id is not None:
986
+ _header_params['TargetTenantID'] = target_tenant_id
987
+ if project_id is not None:
988
+ _header_params['ProjectID'] = project_id
989
+ # process the form parameters
990
+ # process the body parameter
991
+ if delete_permissions_request_dto is not None:
992
+ _body_params = delete_permissions_request_dto
993
+
994
+
995
+ # set the HTTP header `Accept`
996
+ if 'Accept' not in _header_params:
997
+ _header_params['Accept'] = self.api_client.select_header_accept(
998
+ [
999
+ 'application/json'
1000
+ ]
1001
+ )
1002
+
1003
+ # set the HTTP header `Content-Type`
1004
+ if _content_type:
1005
+ _header_params['Content-Type'] = _content_type
1006
+ else:
1007
+ _default_content_type = (
1008
+ self.api_client.select_header_content_type(
1009
+ [
1010
+ 'application/json'
1011
+ ]
1012
+ )
1013
+ )
1014
+ if _default_content_type is not None:
1015
+ _header_params['Content-Type'] = _default_content_type
1016
+
1017
+ # authentication setting
1018
+ _auth_settings: List[str] = [
1019
+ 'CookieAuth',
1020
+ 'ApiKeyAuth',
1021
+ 'OAuth2Auth',
1022
+ 'OAuth2Auth',
1023
+ 'BearerAuth'
1024
+ ]
1025
+
1026
+ return self.api_client.param_serialize(
1027
+ method='DELETE',
1028
+ resource_path='/v1/admin/permissions',
1029
+ path_params=_path_params,
1030
+ query_params=_query_params,
1031
+ header_params=_header_params,
1032
+ body=_body_params,
1033
+ post_params=_form_params,
1034
+ files=_files,
1035
+ auth_settings=_auth_settings,
1036
+ collection_formats=_collection_formats,
1037
+ _host=_host,
1038
+ _request_auth=_request_auth
1039
+ )
1040
+
1041
+
1042
+
1043
+
1044
+ @validate_call
1045
+ def get_capabilities(
1046
+ self,
1047
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None,
1048
+ 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,
1049
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1050
+ _request_timeout: Union[
1051
+ None,
1052
+ Annotated[StrictFloat, Field(gt=0)],
1053
+ Tuple[
1054
+ Annotated[StrictFloat, Field(gt=0)],
1055
+ Annotated[StrictFloat, Field(gt=0)]
1056
+ ]
1057
+ ] = None,
1058
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1059
+ _content_type: Optional[StrictStr] = None,
1060
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1061
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1062
+ ) -> GetCapabilitiesAPIResponseDTO:
1063
+ """Retrieve a list of all permission capabilities
1064
+
1065
+ Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header.
1066
+
1067
+ :param tenant_code: Specify the tenant to retrieve the capabilities from.
1068
+ :type tenant_code: str
1069
+ :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.
1070
+ :type target_tenant_id: str
1071
+ :param project_id: Optionally, specify a project in which to make the request.
1072
+ :type project_id: str
1073
+ :param _request_timeout: timeout setting for this request. If one
1074
+ number provided, it will be total request
1075
+ timeout. It can also be a pair (tuple) of
1076
+ (connection, read) timeouts.
1077
+ :type _request_timeout: int, tuple(int, int), optional
1078
+ :param _request_auth: set to override the auth_settings for an a single
1079
+ request; this effectively ignores the
1080
+ authentication in the spec for a single request.
1081
+ :type _request_auth: dict, optional
1082
+ :param _content_type: force content-type for the request.
1083
+ :type _content_type: str, Optional
1084
+ :param _headers: set to override the headers for a single
1085
+ request; this effectively ignores the headers
1086
+ in the spec for a single request.
1087
+ :type _headers: dict, optional
1088
+ :param _host_index: set to override the host_index for a single
1089
+ request; this effectively ignores the host_index
1090
+ in the spec for a single request.
1091
+ :type _host_index: int, optional
1092
+ :return: Returns the result object.
1093
+ """ # noqa: E501
1094
+
1095
+ _param = self._get_capabilities_serialize(
1096
+ tenant_code=tenant_code,
1097
+ target_tenant_id=target_tenant_id,
1098
+ project_id=project_id,
1099
+ _request_auth=_request_auth,
1100
+ _content_type=_content_type,
1101
+ _headers=_headers,
1102
+ _host_index=_host_index
1103
+ )
1104
+
1105
+ _response_types_map: Dict[str, Optional[str]] = {
1106
+ '200': "GetCapabilitiesAPIResponseDTO",
1107
+ }
1108
+ response_data = self.api_client.call_api(
1109
+ *_param,
1110
+ _request_timeout=_request_timeout
1111
+ )
1112
+ response_data.read()
1113
+ return self.api_client.response_deserialize(
1114
+ response_data=response_data,
1115
+ response_types_map=_response_types_map,
1116
+ ).data
1117
+
1118
+
1119
+ @validate_call
1120
+ def get_capabilities_with_http_info(
1121
+ self,
1122
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None,
1123
+ 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,
1124
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1125
+ _request_timeout: Union[
1126
+ None,
1127
+ Annotated[StrictFloat, Field(gt=0)],
1128
+ Tuple[
1129
+ Annotated[StrictFloat, Field(gt=0)],
1130
+ Annotated[StrictFloat, Field(gt=0)]
1131
+ ]
1132
+ ] = None,
1133
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1134
+ _content_type: Optional[StrictStr] = None,
1135
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1136
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1137
+ ) -> ApiResponse[GetCapabilitiesAPIResponseDTO]:
1138
+ """Retrieve a list of all permission capabilities
1139
+
1140
+ Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header.
1141
+
1142
+ :param tenant_code: Specify the tenant to retrieve the capabilities from.
1143
+ :type tenant_code: str
1144
+ :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.
1145
+ :type target_tenant_id: str
1146
+ :param project_id: Optionally, specify a project in which to make the request.
1147
+ :type project_id: str
1148
+ :param _request_timeout: timeout setting for this request. If one
1149
+ number provided, it will be total request
1150
+ timeout. It can also be a pair (tuple) of
1151
+ (connection, read) timeouts.
1152
+ :type _request_timeout: int, tuple(int, int), optional
1153
+ :param _request_auth: set to override the auth_settings for an a single
1154
+ request; this effectively ignores the
1155
+ authentication in the spec for a single request.
1156
+ :type _request_auth: dict, optional
1157
+ :param _content_type: force content-type for the request.
1158
+ :type _content_type: str, Optional
1159
+ :param _headers: set to override the headers for a single
1160
+ request; this effectively ignores the headers
1161
+ in the spec for a single request.
1162
+ :type _headers: dict, optional
1163
+ :param _host_index: set to override the host_index for a single
1164
+ request; this effectively ignores the host_index
1165
+ in the spec for a single request.
1166
+ :type _host_index: int, optional
1167
+ :return: Returns the result object.
1168
+ """ # noqa: E501
1169
+
1170
+ _param = self._get_capabilities_serialize(
1171
+ tenant_code=tenant_code,
1172
+ target_tenant_id=target_tenant_id,
1173
+ project_id=project_id,
1174
+ _request_auth=_request_auth,
1175
+ _content_type=_content_type,
1176
+ _headers=_headers,
1177
+ _host_index=_host_index
1178
+ )
1179
+
1180
+ _response_types_map: Dict[str, Optional[str]] = {
1181
+ '200': "GetCapabilitiesAPIResponseDTO",
1182
+ }
1183
+ response_data = self.api_client.call_api(
1184
+ *_param,
1185
+ _request_timeout=_request_timeout
1186
+ )
1187
+ response_data.read()
1188
+ return self.api_client.response_deserialize(
1189
+ response_data=response_data,
1190
+ response_types_map=_response_types_map,
1191
+ )
1192
+
1193
+
1194
+ @validate_call
1195
+ def get_capabilities_without_preload_content(
1196
+ self,
1197
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None,
1198
+ 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,
1199
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1200
+ _request_timeout: Union[
1201
+ None,
1202
+ Annotated[StrictFloat, Field(gt=0)],
1203
+ Tuple[
1204
+ Annotated[StrictFloat, Field(gt=0)],
1205
+ Annotated[StrictFloat, Field(gt=0)]
1206
+ ]
1207
+ ] = None,
1208
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1209
+ _content_type: Optional[StrictStr] = None,
1210
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1211
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1212
+ ) -> RESTResponseType:
1213
+ """Retrieve a list of all permission capabilities
1214
+
1215
+ Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header.
1216
+
1217
+ :param tenant_code: Specify the tenant to retrieve the capabilities from.
1218
+ :type tenant_code: str
1219
+ :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.
1220
+ :type target_tenant_id: str
1221
+ :param project_id: Optionally, specify a project in which to make the request.
1222
+ :type project_id: str
1223
+ :param _request_timeout: timeout setting for this request. If one
1224
+ number provided, it will be total request
1225
+ timeout. It can also be a pair (tuple) of
1226
+ (connection, read) timeouts.
1227
+ :type _request_timeout: int, tuple(int, int), optional
1228
+ :param _request_auth: set to override the auth_settings for an a single
1229
+ request; this effectively ignores the
1230
+ authentication in the spec for a single request.
1231
+ :type _request_auth: dict, optional
1232
+ :param _content_type: force content-type for the request.
1233
+ :type _content_type: str, Optional
1234
+ :param _headers: set to override the headers for a single
1235
+ request; this effectively ignores the headers
1236
+ in the spec for a single request.
1237
+ :type _headers: dict, optional
1238
+ :param _host_index: set to override the host_index for a single
1239
+ request; this effectively ignores the host_index
1240
+ in the spec for a single request.
1241
+ :type _host_index: int, optional
1242
+ :return: Returns the result object.
1243
+ """ # noqa: E501
1244
+
1245
+ _param = self._get_capabilities_serialize(
1246
+ tenant_code=tenant_code,
1247
+ target_tenant_id=target_tenant_id,
1248
+ project_id=project_id,
1249
+ _request_auth=_request_auth,
1250
+ _content_type=_content_type,
1251
+ _headers=_headers,
1252
+ _host_index=_host_index
1253
+ )
1254
+
1255
+ _response_types_map: Dict[str, Optional[str]] = {
1256
+ '200': "GetCapabilitiesAPIResponseDTO",
1257
+ }
1258
+ response_data = self.api_client.call_api(
1259
+ *_param,
1260
+ _request_timeout=_request_timeout
1261
+ )
1262
+ return response_data.response
1263
+
1264
+
1265
+ def _get_capabilities_serialize(
1266
+ self,
1267
+ tenant_code,
1268
+ target_tenant_id,
1269
+ project_id,
1270
+ _request_auth,
1271
+ _content_type,
1272
+ _headers,
1273
+ _host_index,
1274
+ ) -> RequestSerialized:
1275
+
1276
+ _host = None
1277
+
1278
+ _collection_formats: Dict[str, str] = {
1279
+ }
1280
+
1281
+ _path_params: Dict[str, str] = {}
1282
+ _query_params: List[Tuple[str, str]] = []
1283
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1284
+ _form_params: List[Tuple[str, str]] = []
1285
+ _files: Dict[
1286
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1287
+ ] = {}
1288
+ _body_params: Optional[bytes] = None
1289
+
1290
+ # process the path parameters
1291
+ # process the query parameters
1292
+ if tenant_code is not None:
1293
+
1294
+ _query_params.append(('tenantCode', tenant_code))
1295
+
1296
+ # process the header parameters
1297
+ if target_tenant_id is not None:
1298
+ _header_params['TargetTenantID'] = target_tenant_id
1299
+ if project_id is not None:
1300
+ _header_params['ProjectID'] = project_id
1301
+ # process the form parameters
1302
+ # process the body parameter
1303
+
1304
+
1305
+ # set the HTTP header `Accept`
1306
+ if 'Accept' not in _header_params:
1307
+ _header_params['Accept'] = self.api_client.select_header_accept(
1308
+ [
1309
+ 'application/json'
1310
+ ]
1311
+ )
1312
+
1313
+
1314
+ # authentication setting
1315
+ _auth_settings: List[str] = [
1316
+ 'CookieAuth',
1317
+ 'ApiKeyAuth',
1318
+ 'OAuth2Auth',
1319
+ 'OAuth2Auth',
1320
+ 'BearerAuth'
1321
+ ]
1322
+
1323
+ return self.api_client.param_serialize(
1324
+ method='GET',
1325
+ resource_path='/v1/admin/capabilities',
1326
+ path_params=_path_params,
1327
+ query_params=_query_params,
1328
+ header_params=_header_params,
1329
+ body=_body_params,
1330
+ post_params=_form_params,
1331
+ files=_files,
1332
+ auth_settings=_auth_settings,
1333
+ collection_formats=_collection_formats,
1334
+ _host=_host,
1335
+ _request_auth=_request_auth
1336
+ )
1337
+
1338
+
1339
+
1340
+
1341
+ @validate_call
1342
+ def get_capability(
1343
+ self,
1344
+ capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")],
1345
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None,
1346
+ 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,
1347
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1348
+ _request_timeout: Union[
1349
+ None,
1350
+ Annotated[StrictFloat, Field(gt=0)],
1351
+ Tuple[
1352
+ Annotated[StrictFloat, Field(gt=0)],
1353
+ Annotated[StrictFloat, Field(gt=0)]
1354
+ ]
1355
+ ] = None,
1356
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1357
+ _content_type: Optional[StrictStr] = None,
1358
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1359
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1360
+ ) -> CapabilityDTO:
1361
+ """Retrieve a permission capability's details
1362
+
1363
+ Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header.
1364
+
1365
+ :param capability_id: The unique identifier of the capability you want to retrieve. (required)
1366
+ :type capability_id: str
1367
+ :param tenant_code: Specify the tenant to retrieve a capability from.
1368
+ :type tenant_code: str
1369
+ :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.
1370
+ :type target_tenant_id: str
1371
+ :param project_id: Optionally, specify a project in which to make the request.
1372
+ :type project_id: str
1373
+ :param _request_timeout: timeout setting for this request. If one
1374
+ number provided, it will be total request
1375
+ timeout. It can also be a pair (tuple) of
1376
+ (connection, read) timeouts.
1377
+ :type _request_timeout: int, tuple(int, int), optional
1378
+ :param _request_auth: set to override the auth_settings for an a single
1379
+ request; this effectively ignores the
1380
+ authentication in the spec for a single request.
1381
+ :type _request_auth: dict, optional
1382
+ :param _content_type: force content-type for the request.
1383
+ :type _content_type: str, Optional
1384
+ :param _headers: set to override the headers for a single
1385
+ request; this effectively ignores the headers
1386
+ in the spec for a single request.
1387
+ :type _headers: dict, optional
1388
+ :param _host_index: set to override the host_index for a single
1389
+ request; this effectively ignores the host_index
1390
+ in the spec for a single request.
1391
+ :type _host_index: int, optional
1392
+ :return: Returns the result object.
1393
+ """ # noqa: E501
1394
+
1395
+ _param = self._get_capability_serialize(
1396
+ capability_id=capability_id,
1397
+ tenant_code=tenant_code,
1398
+ target_tenant_id=target_tenant_id,
1399
+ project_id=project_id,
1400
+ _request_auth=_request_auth,
1401
+ _content_type=_content_type,
1402
+ _headers=_headers,
1403
+ _host_index=_host_index
1404
+ )
1405
+
1406
+ _response_types_map: Dict[str, Optional[str]] = {
1407
+ '200': "CapabilityDTO",
1408
+ }
1409
+ response_data = self.api_client.call_api(
1410
+ *_param,
1411
+ _request_timeout=_request_timeout
1412
+ )
1413
+ response_data.read()
1414
+ return self.api_client.response_deserialize(
1415
+ response_data=response_data,
1416
+ response_types_map=_response_types_map,
1417
+ ).data
1418
+
1419
+
1420
+ @validate_call
1421
+ def get_capability_with_http_info(
1422
+ self,
1423
+ capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")],
1424
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None,
1425
+ 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,
1426
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1427
+ _request_timeout: Union[
1428
+ None,
1429
+ Annotated[StrictFloat, Field(gt=0)],
1430
+ Tuple[
1431
+ Annotated[StrictFloat, Field(gt=0)],
1432
+ Annotated[StrictFloat, Field(gt=0)]
1433
+ ]
1434
+ ] = None,
1435
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1436
+ _content_type: Optional[StrictStr] = None,
1437
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1438
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1439
+ ) -> ApiResponse[CapabilityDTO]:
1440
+ """Retrieve a permission capability's details
1441
+
1442
+ Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header.
1443
+
1444
+ :param capability_id: The unique identifier of the capability you want to retrieve. (required)
1445
+ :type capability_id: str
1446
+ :param tenant_code: Specify the tenant to retrieve a capability from.
1447
+ :type tenant_code: str
1448
+ :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.
1449
+ :type target_tenant_id: str
1450
+ :param project_id: Optionally, specify a project in which to make the request.
1451
+ :type project_id: str
1452
+ :param _request_timeout: timeout setting for this request. If one
1453
+ number provided, it will be total request
1454
+ timeout. It can also be a pair (tuple) of
1455
+ (connection, read) timeouts.
1456
+ :type _request_timeout: int, tuple(int, int), optional
1457
+ :param _request_auth: set to override the auth_settings for an a single
1458
+ request; this effectively ignores the
1459
+ authentication in the spec for a single request.
1460
+ :type _request_auth: dict, optional
1461
+ :param _content_type: force content-type for the request.
1462
+ :type _content_type: str, Optional
1463
+ :param _headers: set to override the headers for a single
1464
+ request; this effectively ignores the headers
1465
+ in the spec for a single request.
1466
+ :type _headers: dict, optional
1467
+ :param _host_index: set to override the host_index for a single
1468
+ request; this effectively ignores the host_index
1469
+ in the spec for a single request.
1470
+ :type _host_index: int, optional
1471
+ :return: Returns the result object.
1472
+ """ # noqa: E501
1473
+
1474
+ _param = self._get_capability_serialize(
1475
+ capability_id=capability_id,
1476
+ tenant_code=tenant_code,
1477
+ target_tenant_id=target_tenant_id,
1478
+ project_id=project_id,
1479
+ _request_auth=_request_auth,
1480
+ _content_type=_content_type,
1481
+ _headers=_headers,
1482
+ _host_index=_host_index
1483
+ )
1484
+
1485
+ _response_types_map: Dict[str, Optional[str]] = {
1486
+ '200': "CapabilityDTO",
1487
+ }
1488
+ response_data = self.api_client.call_api(
1489
+ *_param,
1490
+ _request_timeout=_request_timeout
1491
+ )
1492
+ response_data.read()
1493
+ return self.api_client.response_deserialize(
1494
+ response_data=response_data,
1495
+ response_types_map=_response_types_map,
1496
+ )
1497
+
1498
+
1499
+ @validate_call
1500
+ def get_capability_without_preload_content(
1501
+ self,
1502
+ capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")],
1503
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None,
1504
+ 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,
1505
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1506
+ _request_timeout: Union[
1507
+ None,
1508
+ Annotated[StrictFloat, Field(gt=0)],
1509
+ Tuple[
1510
+ Annotated[StrictFloat, Field(gt=0)],
1511
+ Annotated[StrictFloat, Field(gt=0)]
1512
+ ]
1513
+ ] = None,
1514
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1515
+ _content_type: Optional[StrictStr] = None,
1516
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1517
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1518
+ ) -> RESTResponseType:
1519
+ """Retrieve a permission capability's details
1520
+
1521
+ Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header.
1522
+
1523
+ :param capability_id: The unique identifier of the capability you want to retrieve. (required)
1524
+ :type capability_id: str
1525
+ :param tenant_code: Specify the tenant to retrieve a capability from.
1526
+ :type tenant_code: str
1527
+ :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.
1528
+ :type target_tenant_id: str
1529
+ :param project_id: Optionally, specify a project in which to make the request.
1530
+ :type project_id: str
1531
+ :param _request_timeout: timeout setting for this request. If one
1532
+ number provided, it will be total request
1533
+ timeout. It can also be a pair (tuple) of
1534
+ (connection, read) timeouts.
1535
+ :type _request_timeout: int, tuple(int, int), optional
1536
+ :param _request_auth: set to override the auth_settings for an a single
1537
+ request; this effectively ignores the
1538
+ authentication in the spec for a single request.
1539
+ :type _request_auth: dict, optional
1540
+ :param _content_type: force content-type for the request.
1541
+ :type _content_type: str, Optional
1542
+ :param _headers: set to override the headers for a single
1543
+ request; this effectively ignores the headers
1544
+ in the spec for a single request.
1545
+ :type _headers: dict, optional
1546
+ :param _host_index: set to override the host_index for a single
1547
+ request; this effectively ignores the host_index
1548
+ in the spec for a single request.
1549
+ :type _host_index: int, optional
1550
+ :return: Returns the result object.
1551
+ """ # noqa: E501
1552
+
1553
+ _param = self._get_capability_serialize(
1554
+ capability_id=capability_id,
1555
+ tenant_code=tenant_code,
1556
+ target_tenant_id=target_tenant_id,
1557
+ project_id=project_id,
1558
+ _request_auth=_request_auth,
1559
+ _content_type=_content_type,
1560
+ _headers=_headers,
1561
+ _host_index=_host_index
1562
+ )
1563
+
1564
+ _response_types_map: Dict[str, Optional[str]] = {
1565
+ '200': "CapabilityDTO",
1566
+ }
1567
+ response_data = self.api_client.call_api(
1568
+ *_param,
1569
+ _request_timeout=_request_timeout
1570
+ )
1571
+ return response_data.response
1572
+
1573
+
1574
+ def _get_capability_serialize(
1575
+ self,
1576
+ capability_id,
1577
+ tenant_code,
1578
+ target_tenant_id,
1579
+ project_id,
1580
+ _request_auth,
1581
+ _content_type,
1582
+ _headers,
1583
+ _host_index,
1584
+ ) -> RequestSerialized:
1585
+
1586
+ _host = None
1587
+
1588
+ _collection_formats: Dict[str, str] = {
1589
+ }
1590
+
1591
+ _path_params: Dict[str, str] = {}
1592
+ _query_params: List[Tuple[str, str]] = []
1593
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1594
+ _form_params: List[Tuple[str, str]] = []
1595
+ _files: Dict[
1596
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1597
+ ] = {}
1598
+ _body_params: Optional[bytes] = None
1599
+
1600
+ # process the path parameters
1601
+ if capability_id is not None:
1602
+ _path_params['capabilityId'] = capability_id
1603
+ # process the query parameters
1604
+ if tenant_code is not None:
1605
+
1606
+ _query_params.append(('tenantCode', tenant_code))
1607
+
1608
+ # process the header parameters
1609
+ if target_tenant_id is not None:
1610
+ _header_params['TargetTenantID'] = target_tenant_id
1611
+ if project_id is not None:
1612
+ _header_params['ProjectID'] = project_id
1613
+ # process the form parameters
1614
+ # process the body parameter
1615
+
1616
+
1617
+ # set the HTTP header `Accept`
1618
+ if 'Accept' not in _header_params:
1619
+ _header_params['Accept'] = self.api_client.select_header_accept(
1620
+ [
1621
+ 'application/json'
1622
+ ]
1623
+ )
1624
+
1625
+
1626
+ # authentication setting
1627
+ _auth_settings: List[str] = [
1628
+ 'CookieAuth',
1629
+ 'ApiKeyAuth',
1630
+ 'OAuth2Auth',
1631
+ 'OAuth2Auth',
1632
+ 'BearerAuth'
1633
+ ]
1634
+
1635
+ return self.api_client.param_serialize(
1636
+ method='GET',
1637
+ resource_path='/v1/admin/capabilities/{capabilityId}',
1638
+ path_params=_path_params,
1639
+ query_params=_query_params,
1640
+ header_params=_header_params,
1641
+ body=_body_params,
1642
+ post_params=_form_params,
1643
+ files=_files,
1644
+ auth_settings=_auth_settings,
1645
+ collection_formats=_collection_formats,
1646
+ _host=_host,
1647
+ _request_auth=_request_auth
1648
+ )
1649
+
1650
+
1651
+
1652
+
1653
+ @validate_call
1654
+ def get_content_package(
1655
+ self,
1656
+ content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")],
1657
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None,
1658
+ 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,
1659
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1660
+ _request_timeout: Union[
1661
+ None,
1662
+ Annotated[StrictFloat, Field(gt=0)],
1663
+ Tuple[
1664
+ Annotated[StrictFloat, Field(gt=0)],
1665
+ Annotated[StrictFloat, Field(gt=0)]
1666
+ ]
1667
+ ] = None,
1668
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1669
+ _content_type: Optional[StrictStr] = None,
1670
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1671
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1672
+ ) -> ContentPackageDTO:
1673
+ """Retrieve a content package's details
1674
+
1675
+ Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header.
1676
+
1677
+ :param content_package_id: The unique identifier of the content package you want to retrieve. (required)
1678
+ :type content_package_id: str
1679
+ :param tenant_code: Specify the tenant to retrieve a content package from.
1680
+ :type tenant_code: str
1681
+ :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.
1682
+ :type target_tenant_id: str
1683
+ :param project_id: Optionally, specify a project in which to make the request.
1684
+ :type project_id: str
1685
+ :param _request_timeout: timeout setting for this request. If one
1686
+ number provided, it will be total request
1687
+ timeout. It can also be a pair (tuple) of
1688
+ (connection, read) timeouts.
1689
+ :type _request_timeout: int, tuple(int, int), optional
1690
+ :param _request_auth: set to override the auth_settings for an a single
1691
+ request; this effectively ignores the
1692
+ authentication in the spec for a single request.
1693
+ :type _request_auth: dict, optional
1694
+ :param _content_type: force content-type for the request.
1695
+ :type _content_type: str, Optional
1696
+ :param _headers: set to override the headers for a single
1697
+ request; this effectively ignores the headers
1698
+ in the spec for a single request.
1699
+ :type _headers: dict, optional
1700
+ :param _host_index: set to override the host_index for a single
1701
+ request; this effectively ignores the host_index
1702
+ in the spec for a single request.
1703
+ :type _host_index: int, optional
1704
+ :return: Returns the result object.
1705
+ """ # noqa: E501
1706
+
1707
+ _param = self._get_content_package_serialize(
1708
+ content_package_id=content_package_id,
1709
+ tenant_code=tenant_code,
1710
+ target_tenant_id=target_tenant_id,
1711
+ project_id=project_id,
1712
+ _request_auth=_request_auth,
1713
+ _content_type=_content_type,
1714
+ _headers=_headers,
1715
+ _host_index=_host_index
1716
+ )
1717
+
1718
+ _response_types_map: Dict[str, Optional[str]] = {
1719
+ '200': "ContentPackageDTO",
1720
+ }
1721
+ response_data = self.api_client.call_api(
1722
+ *_param,
1723
+ _request_timeout=_request_timeout
1724
+ )
1725
+ response_data.read()
1726
+ return self.api_client.response_deserialize(
1727
+ response_data=response_data,
1728
+ response_types_map=_response_types_map,
1729
+ ).data
1730
+
1731
+
1732
+ @validate_call
1733
+ def get_content_package_with_http_info(
1734
+ self,
1735
+ content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")],
1736
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None,
1737
+ 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,
1738
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1739
+ _request_timeout: Union[
1740
+ None,
1741
+ Annotated[StrictFloat, Field(gt=0)],
1742
+ Tuple[
1743
+ Annotated[StrictFloat, Field(gt=0)],
1744
+ Annotated[StrictFloat, Field(gt=0)]
1745
+ ]
1746
+ ] = None,
1747
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1748
+ _content_type: Optional[StrictStr] = None,
1749
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1750
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1751
+ ) -> ApiResponse[ContentPackageDTO]:
1752
+ """Retrieve a content package's details
1753
+
1754
+ Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header.
1755
+
1756
+ :param content_package_id: The unique identifier of the content package you want to retrieve. (required)
1757
+ :type content_package_id: str
1758
+ :param tenant_code: Specify the tenant to retrieve a content package from.
1759
+ :type tenant_code: str
1760
+ :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.
1761
+ :type target_tenant_id: str
1762
+ :param project_id: Optionally, specify a project in which to make the request.
1763
+ :type project_id: str
1764
+ :param _request_timeout: timeout setting for this request. If one
1765
+ number provided, it will be total request
1766
+ timeout. It can also be a pair (tuple) of
1767
+ (connection, read) timeouts.
1768
+ :type _request_timeout: int, tuple(int, int), optional
1769
+ :param _request_auth: set to override the auth_settings for an a single
1770
+ request; this effectively ignores the
1771
+ authentication in the spec for a single request.
1772
+ :type _request_auth: dict, optional
1773
+ :param _content_type: force content-type for the request.
1774
+ :type _content_type: str, Optional
1775
+ :param _headers: set to override the headers for a single
1776
+ request; this effectively ignores the headers
1777
+ in the spec for a single request.
1778
+ :type _headers: dict, optional
1779
+ :param _host_index: set to override the host_index for a single
1780
+ request; this effectively ignores the host_index
1781
+ in the spec for a single request.
1782
+ :type _host_index: int, optional
1783
+ :return: Returns the result object.
1784
+ """ # noqa: E501
1785
+
1786
+ _param = self._get_content_package_serialize(
1787
+ content_package_id=content_package_id,
1788
+ tenant_code=tenant_code,
1789
+ target_tenant_id=target_tenant_id,
1790
+ project_id=project_id,
1791
+ _request_auth=_request_auth,
1792
+ _content_type=_content_type,
1793
+ _headers=_headers,
1794
+ _host_index=_host_index
1795
+ )
1796
+
1797
+ _response_types_map: Dict[str, Optional[str]] = {
1798
+ '200': "ContentPackageDTO",
1799
+ }
1800
+ response_data = self.api_client.call_api(
1801
+ *_param,
1802
+ _request_timeout=_request_timeout
1803
+ )
1804
+ response_data.read()
1805
+ return self.api_client.response_deserialize(
1806
+ response_data=response_data,
1807
+ response_types_map=_response_types_map,
1808
+ )
1809
+
1810
+
1811
+ @validate_call
1812
+ def get_content_package_without_preload_content(
1813
+ self,
1814
+ content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")],
1815
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None,
1816
+ 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,
1817
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
1818
+ _request_timeout: Union[
1819
+ None,
1820
+ Annotated[StrictFloat, Field(gt=0)],
1821
+ Tuple[
1822
+ Annotated[StrictFloat, Field(gt=0)],
1823
+ Annotated[StrictFloat, Field(gt=0)]
1824
+ ]
1825
+ ] = None,
1826
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1827
+ _content_type: Optional[StrictStr] = None,
1828
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1829
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1830
+ ) -> RESTResponseType:
1831
+ """Retrieve a content package's details
1832
+
1833
+ Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header.
1834
+
1835
+ :param content_package_id: The unique identifier of the content package you want to retrieve. (required)
1836
+ :type content_package_id: str
1837
+ :param tenant_code: Specify the tenant to retrieve a content package from.
1838
+ :type tenant_code: str
1839
+ :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.
1840
+ :type target_tenant_id: str
1841
+ :param project_id: Optionally, specify a project in which to make the request.
1842
+ :type project_id: str
1843
+ :param _request_timeout: timeout setting for this request. If one
1844
+ number provided, it will be total request
1845
+ timeout. It can also be a pair (tuple) of
1846
+ (connection, read) timeouts.
1847
+ :type _request_timeout: int, tuple(int, int), optional
1848
+ :param _request_auth: set to override the auth_settings for an a single
1849
+ request; this effectively ignores the
1850
+ authentication in the spec for a single request.
1851
+ :type _request_auth: dict, optional
1852
+ :param _content_type: force content-type for the request.
1853
+ :type _content_type: str, Optional
1854
+ :param _headers: set to override the headers for a single
1855
+ request; this effectively ignores the headers
1856
+ in the spec for a single request.
1857
+ :type _headers: dict, optional
1858
+ :param _host_index: set to override the host_index for a single
1859
+ request; this effectively ignores the host_index
1860
+ in the spec for a single request.
1861
+ :type _host_index: int, optional
1862
+ :return: Returns the result object.
1863
+ """ # noqa: E501
1864
+
1865
+ _param = self._get_content_package_serialize(
1866
+ content_package_id=content_package_id,
1867
+ tenant_code=tenant_code,
1868
+ target_tenant_id=target_tenant_id,
1869
+ project_id=project_id,
1870
+ _request_auth=_request_auth,
1871
+ _content_type=_content_type,
1872
+ _headers=_headers,
1873
+ _host_index=_host_index
1874
+ )
1875
+
1876
+ _response_types_map: Dict[str, Optional[str]] = {
1877
+ '200': "ContentPackageDTO",
1878
+ }
1879
+ response_data = self.api_client.call_api(
1880
+ *_param,
1881
+ _request_timeout=_request_timeout
1882
+ )
1883
+ return response_data.response
1884
+
1885
+
1886
+ def _get_content_package_serialize(
1887
+ self,
1888
+ content_package_id,
1889
+ tenant_code,
1890
+ target_tenant_id,
1891
+ project_id,
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
+ if content_package_id is not None:
1914
+ _path_params['contentPackageId'] = content_package_id
1915
+ # process the query parameters
1916
+ if tenant_code is not None:
1917
+
1918
+ _query_params.append(('tenantCode', tenant_code))
1919
+
1920
+ # process the header parameters
1921
+ if target_tenant_id is not None:
1922
+ _header_params['TargetTenantID'] = target_tenant_id
1923
+ if project_id is not None:
1924
+ _header_params['ProjectID'] = project_id
1925
+ # process the form parameters
1926
+ # process the body parameter
1927
+
1928
+
1929
+ # set the HTTP header `Accept`
1930
+ if 'Accept' not in _header_params:
1931
+ _header_params['Accept'] = self.api_client.select_header_accept(
1932
+ [
1933
+ 'application/json'
1934
+ ]
1935
+ )
1936
+
1937
+
1938
+ # authentication setting
1939
+ _auth_settings: List[str] = [
1940
+ 'CookieAuth',
1941
+ 'ApiKeyAuth',
1942
+ 'OAuth2Auth',
1943
+ 'OAuth2Auth',
1944
+ 'BearerAuth'
1945
+ ]
1946
+
1947
+ return self.api_client.param_serialize(
1948
+ method='GET',
1949
+ resource_path='/v1/admin/content-packages/{contentPackageId}',
1950
+ path_params=_path_params,
1951
+ query_params=_query_params,
1952
+ header_params=_header_params,
1953
+ body=_body_params,
1954
+ post_params=_form_params,
1955
+ files=_files,
1956
+ auth_settings=_auth_settings,
1957
+ collection_formats=_collection_formats,
1958
+ _host=_host,
1959
+ _request_auth=_request_auth
1960
+ )
1961
+
1962
+
1963
+
1964
+
1965
+ @validate_call
1966
+ def get_content_packages(
1967
+ self,
1968
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None,
1969
+ search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None,
1970
+ 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,
1971
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
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
+ ) -> GetContentPackagesAPIResponseDTO:
1985
+ """Retrieve a list of all content packages
1986
+
1987
+ Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header.
1988
+
1989
+ :param tenant_code: Specify the tenant to retrieve the content packages from.
1990
+ :type tenant_code: str
1991
+ :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.
1992
+ :type search_string: str
1993
+ :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.
1994
+ :type target_tenant_id: str
1995
+ :param project_id: Optionally, specify a project in which to make the request.
1996
+ :type project_id: str
1997
+ :param _request_timeout: timeout setting for this request. If one
1998
+ number provided, it will be total request
1999
+ timeout. It can also be a pair (tuple) of
2000
+ (connection, read) timeouts.
2001
+ :type _request_timeout: int, tuple(int, int), optional
2002
+ :param _request_auth: set to override the auth_settings for an a single
2003
+ request; this effectively ignores the
2004
+ authentication in the spec for a single request.
2005
+ :type _request_auth: dict, optional
2006
+ :param _content_type: force content-type for the request.
2007
+ :type _content_type: str, Optional
2008
+ :param _headers: set to override the headers for a single
2009
+ request; this effectively ignores the headers
2010
+ in the spec for a single request.
2011
+ :type _headers: dict, optional
2012
+ :param _host_index: set to override the host_index for a single
2013
+ request; this effectively ignores the host_index
2014
+ in the spec for a single request.
2015
+ :type _host_index: int, optional
2016
+ :return: Returns the result object.
2017
+ """ # noqa: E501
2018
+
2019
+ _param = self._get_content_packages_serialize(
2020
+ tenant_code=tenant_code,
2021
+ search_string=search_string,
2022
+ target_tenant_id=target_tenant_id,
2023
+ project_id=project_id,
2024
+ _request_auth=_request_auth,
2025
+ _content_type=_content_type,
2026
+ _headers=_headers,
2027
+ _host_index=_host_index
2028
+ )
2029
+
2030
+ _response_types_map: Dict[str, Optional[str]] = {
2031
+ '200': "GetContentPackagesAPIResponseDTO",
2032
+ }
2033
+ response_data = self.api_client.call_api(
2034
+ *_param,
2035
+ _request_timeout=_request_timeout
2036
+ )
2037
+ response_data.read()
2038
+ return self.api_client.response_deserialize(
2039
+ response_data=response_data,
2040
+ response_types_map=_response_types_map,
2041
+ ).data
2042
+
2043
+
2044
+ @validate_call
2045
+ def get_content_packages_with_http_info(
2046
+ self,
2047
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None,
2048
+ search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None,
2049
+ 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,
2050
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2051
+ _request_timeout: Union[
2052
+ None,
2053
+ Annotated[StrictFloat, Field(gt=0)],
2054
+ Tuple[
2055
+ Annotated[StrictFloat, Field(gt=0)],
2056
+ Annotated[StrictFloat, Field(gt=0)]
2057
+ ]
2058
+ ] = None,
2059
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2060
+ _content_type: Optional[StrictStr] = None,
2061
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2062
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2063
+ ) -> ApiResponse[GetContentPackagesAPIResponseDTO]:
2064
+ """Retrieve a list of all content packages
2065
+
2066
+ Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header.
2067
+
2068
+ :param tenant_code: Specify the tenant to retrieve the content packages from.
2069
+ :type tenant_code: str
2070
+ :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.
2071
+ :type search_string: str
2072
+ :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.
2073
+ :type target_tenant_id: str
2074
+ :param project_id: Optionally, specify a project in which to make the request.
2075
+ :type project_id: str
2076
+ :param _request_timeout: timeout setting for this request. If one
2077
+ number provided, it will be total request
2078
+ timeout. It can also be a pair (tuple) of
2079
+ (connection, read) timeouts.
2080
+ :type _request_timeout: int, tuple(int, int), optional
2081
+ :param _request_auth: set to override the auth_settings for an a single
2082
+ request; this effectively ignores the
2083
+ authentication in the spec for a single request.
2084
+ :type _request_auth: dict, optional
2085
+ :param _content_type: force content-type for the request.
2086
+ :type _content_type: str, Optional
2087
+ :param _headers: set to override the headers for a single
2088
+ request; this effectively ignores the headers
2089
+ in the spec for a single request.
2090
+ :type _headers: dict, optional
2091
+ :param _host_index: set to override the host_index for a single
2092
+ request; this effectively ignores the host_index
2093
+ in the spec for a single request.
2094
+ :type _host_index: int, optional
2095
+ :return: Returns the result object.
2096
+ """ # noqa: E501
2097
+
2098
+ _param = self._get_content_packages_serialize(
2099
+ tenant_code=tenant_code,
2100
+ search_string=search_string,
2101
+ target_tenant_id=target_tenant_id,
2102
+ project_id=project_id,
2103
+ _request_auth=_request_auth,
2104
+ _content_type=_content_type,
2105
+ _headers=_headers,
2106
+ _host_index=_host_index
2107
+ )
2108
+
2109
+ _response_types_map: Dict[str, Optional[str]] = {
2110
+ '200': "GetContentPackagesAPIResponseDTO",
2111
+ }
2112
+ response_data = self.api_client.call_api(
2113
+ *_param,
2114
+ _request_timeout=_request_timeout
2115
+ )
2116
+ response_data.read()
2117
+ return self.api_client.response_deserialize(
2118
+ response_data=response_data,
2119
+ response_types_map=_response_types_map,
2120
+ )
2121
+
2122
+
2123
+ @validate_call
2124
+ def get_content_packages_without_preload_content(
2125
+ self,
2126
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None,
2127
+ search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None,
2128
+ 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,
2129
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2130
+ _request_timeout: Union[
2131
+ None,
2132
+ Annotated[StrictFloat, Field(gt=0)],
2133
+ Tuple[
2134
+ Annotated[StrictFloat, Field(gt=0)],
2135
+ Annotated[StrictFloat, Field(gt=0)]
2136
+ ]
2137
+ ] = None,
2138
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2139
+ _content_type: Optional[StrictStr] = None,
2140
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2141
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2142
+ ) -> RESTResponseType:
2143
+ """Retrieve a list of all content packages
2144
+
2145
+ Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header.
2146
+
2147
+ :param tenant_code: Specify the tenant to retrieve the content packages from.
2148
+ :type tenant_code: str
2149
+ :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.
2150
+ :type search_string: str
2151
+ :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.
2152
+ :type target_tenant_id: str
2153
+ :param project_id: Optionally, specify a project in which to make the request.
2154
+ :type project_id: str
2155
+ :param _request_timeout: timeout setting for this request. If one
2156
+ number provided, it will be total request
2157
+ timeout. It can also be a pair (tuple) of
2158
+ (connection, read) timeouts.
2159
+ :type _request_timeout: int, tuple(int, int), optional
2160
+ :param _request_auth: set to override the auth_settings for an a single
2161
+ request; this effectively ignores the
2162
+ authentication in the spec for a single request.
2163
+ :type _request_auth: dict, optional
2164
+ :param _content_type: force content-type for the request.
2165
+ :type _content_type: str, Optional
2166
+ :param _headers: set to override the headers for a single
2167
+ request; this effectively ignores the headers
2168
+ in the spec for a single request.
2169
+ :type _headers: dict, optional
2170
+ :param _host_index: set to override the host_index for a single
2171
+ request; this effectively ignores the host_index
2172
+ in the spec for a single request.
2173
+ :type _host_index: int, optional
2174
+ :return: Returns the result object.
2175
+ """ # noqa: E501
2176
+
2177
+ _param = self._get_content_packages_serialize(
2178
+ tenant_code=tenant_code,
2179
+ search_string=search_string,
2180
+ target_tenant_id=target_tenant_id,
2181
+ project_id=project_id,
2182
+ _request_auth=_request_auth,
2183
+ _content_type=_content_type,
2184
+ _headers=_headers,
2185
+ _host_index=_host_index
2186
+ )
2187
+
2188
+ _response_types_map: Dict[str, Optional[str]] = {
2189
+ '200': "GetContentPackagesAPIResponseDTO",
2190
+ }
2191
+ response_data = self.api_client.call_api(
2192
+ *_param,
2193
+ _request_timeout=_request_timeout
2194
+ )
2195
+ return response_data.response
2196
+
2197
+
2198
+ def _get_content_packages_serialize(
2199
+ self,
2200
+ tenant_code,
2201
+ search_string,
2202
+ target_tenant_id,
2203
+ project_id,
2204
+ _request_auth,
2205
+ _content_type,
2206
+ _headers,
2207
+ _host_index,
2208
+ ) -> RequestSerialized:
2209
+
2210
+ _host = None
2211
+
2212
+ _collection_formats: Dict[str, str] = {
2213
+ }
2214
+
2215
+ _path_params: Dict[str, str] = {}
2216
+ _query_params: List[Tuple[str, str]] = []
2217
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2218
+ _form_params: List[Tuple[str, str]] = []
2219
+ _files: Dict[
2220
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2221
+ ] = {}
2222
+ _body_params: Optional[bytes] = None
2223
+
2224
+ # process the path parameters
2225
+ # process the query parameters
2226
+ if tenant_code is not None:
2227
+
2228
+ _query_params.append(('tenantCode', tenant_code))
2229
+
2230
+ if search_string is not None:
2231
+
2232
+ _query_params.append(('searchString', search_string))
2233
+
2234
+ # process the header parameters
2235
+ if target_tenant_id is not None:
2236
+ _header_params['TargetTenantID'] = target_tenant_id
2237
+ if project_id is not None:
2238
+ _header_params['ProjectID'] = project_id
2239
+ # process the form parameters
2240
+ # process the body parameter
2241
+
2242
+
2243
+ # set the HTTP header `Accept`
2244
+ if 'Accept' not in _header_params:
2245
+ _header_params['Accept'] = self.api_client.select_header_accept(
2246
+ [
2247
+ 'application/json'
2248
+ ]
2249
+ )
2250
+
2251
+
2252
+ # authentication setting
2253
+ _auth_settings: List[str] = [
2254
+ 'CookieAuth',
2255
+ 'ApiKeyAuth',
2256
+ 'OAuth2Auth',
2257
+ 'OAuth2Auth',
2258
+ 'BearerAuth'
2259
+ ]
2260
+
2261
+ return self.api_client.param_serialize(
2262
+ method='GET',
2263
+ resource_path='/v1/admin/content-packages',
2264
+ path_params=_path_params,
2265
+ query_params=_query_params,
2266
+ header_params=_header_params,
2267
+ body=_body_params,
2268
+ post_params=_form_params,
2269
+ files=_files,
2270
+ auth_settings=_auth_settings,
2271
+ collection_formats=_collection_formats,
2272
+ _host=_host,
2273
+ _request_auth=_request_auth
2274
+ )
2275
+
2276
+
2277
+
2278
+
2279
+ @validate_call
2280
+ def get_data_access_set(
2281
+ self,
2282
+ data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")],
2283
+ 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,
2284
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2285
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2286
+ _request_timeout: Union[
2287
+ None,
2288
+ Annotated[StrictFloat, Field(gt=0)],
2289
+ Tuple[
2290
+ Annotated[StrictFloat, Field(gt=0)],
2291
+ Annotated[StrictFloat, Field(gt=0)]
2292
+ ]
2293
+ ] = None,
2294
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2295
+ _content_type: Optional[StrictStr] = None,
2296
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2297
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2298
+ ) -> DataAccessSetDTO:
2299
+ """Retrieve a data access set's details
2300
+
2301
+ Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header.
2302
+
2303
+ :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required)
2304
+ :type data_access_set_id: str
2305
+ :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.
2306
+ :type target_tenant_id: str
2307
+ :param project_id: Optionally, specify a project in which to make the request.
2308
+ :type project_id: str
2309
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2310
+ :type non_versioned: bool
2311
+ :param _request_timeout: timeout setting for this request. If one
2312
+ number provided, it will be total request
2313
+ timeout. It can also be a pair (tuple) of
2314
+ (connection, read) timeouts.
2315
+ :type _request_timeout: int, tuple(int, int), optional
2316
+ :param _request_auth: set to override the auth_settings for an a single
2317
+ request; this effectively ignores the
2318
+ authentication in the spec for a single request.
2319
+ :type _request_auth: dict, optional
2320
+ :param _content_type: force content-type for the request.
2321
+ :type _content_type: str, Optional
2322
+ :param _headers: set to override the headers for a single
2323
+ request; this effectively ignores the headers
2324
+ in the spec for a single request.
2325
+ :type _headers: dict, optional
2326
+ :param _host_index: set to override the host_index for a single
2327
+ request; this effectively ignores the host_index
2328
+ in the spec for a single request.
2329
+ :type _host_index: int, optional
2330
+ :return: Returns the result object.
2331
+ """ # noqa: E501
2332
+
2333
+ _param = self._get_data_access_set_serialize(
2334
+ data_access_set_id=data_access_set_id,
2335
+ target_tenant_id=target_tenant_id,
2336
+ project_id=project_id,
2337
+ non_versioned=non_versioned,
2338
+ _request_auth=_request_auth,
2339
+ _content_type=_content_type,
2340
+ _headers=_headers,
2341
+ _host_index=_host_index
2342
+ )
2343
+
2344
+ _response_types_map: Dict[str, Optional[str]] = {
2345
+ '200': "DataAccessSetDTO",
2346
+ }
2347
+ response_data = self.api_client.call_api(
2348
+ *_param,
2349
+ _request_timeout=_request_timeout
2350
+ )
2351
+ response_data.read()
2352
+ return self.api_client.response_deserialize(
2353
+ response_data=response_data,
2354
+ response_types_map=_response_types_map,
2355
+ ).data
2356
+
2357
+
2358
+ @validate_call
2359
+ def get_data_access_set_with_http_info(
2360
+ self,
2361
+ data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")],
2362
+ 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,
2363
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2364
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2365
+ _request_timeout: Union[
2366
+ None,
2367
+ Annotated[StrictFloat, Field(gt=0)],
2368
+ Tuple[
2369
+ Annotated[StrictFloat, Field(gt=0)],
2370
+ Annotated[StrictFloat, Field(gt=0)]
2371
+ ]
2372
+ ] = None,
2373
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2374
+ _content_type: Optional[StrictStr] = None,
2375
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2376
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2377
+ ) -> ApiResponse[DataAccessSetDTO]:
2378
+ """Retrieve a data access set's details
2379
+
2380
+ Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header.
2381
+
2382
+ :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required)
2383
+ :type data_access_set_id: str
2384
+ :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.
2385
+ :type target_tenant_id: str
2386
+ :param project_id: Optionally, specify a project in which to make the request.
2387
+ :type project_id: str
2388
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2389
+ :type non_versioned: bool
2390
+ :param _request_timeout: timeout setting for this request. If one
2391
+ number provided, it will be total request
2392
+ timeout. It can also be a pair (tuple) of
2393
+ (connection, read) timeouts.
2394
+ :type _request_timeout: int, tuple(int, int), optional
2395
+ :param _request_auth: set to override the auth_settings for an a single
2396
+ request; this effectively ignores the
2397
+ authentication in the spec for a single request.
2398
+ :type _request_auth: dict, optional
2399
+ :param _content_type: force content-type for the request.
2400
+ :type _content_type: str, Optional
2401
+ :param _headers: set to override the headers for a single
2402
+ request; this effectively ignores the headers
2403
+ in the spec for a single request.
2404
+ :type _headers: dict, optional
2405
+ :param _host_index: set to override the host_index for a single
2406
+ request; this effectively ignores the host_index
2407
+ in the spec for a single request.
2408
+ :type _host_index: int, optional
2409
+ :return: Returns the result object.
2410
+ """ # noqa: E501
2411
+
2412
+ _param = self._get_data_access_set_serialize(
2413
+ data_access_set_id=data_access_set_id,
2414
+ target_tenant_id=target_tenant_id,
2415
+ project_id=project_id,
2416
+ non_versioned=non_versioned,
2417
+ _request_auth=_request_auth,
2418
+ _content_type=_content_type,
2419
+ _headers=_headers,
2420
+ _host_index=_host_index
2421
+ )
2422
+
2423
+ _response_types_map: Dict[str, Optional[str]] = {
2424
+ '200': "DataAccessSetDTO",
2425
+ }
2426
+ response_data = self.api_client.call_api(
2427
+ *_param,
2428
+ _request_timeout=_request_timeout
2429
+ )
2430
+ response_data.read()
2431
+ return self.api_client.response_deserialize(
2432
+ response_data=response_data,
2433
+ response_types_map=_response_types_map,
2434
+ )
2435
+
2436
+
2437
+ @validate_call
2438
+ def get_data_access_set_without_preload_content(
2439
+ self,
2440
+ data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")],
2441
+ 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,
2442
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2443
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2444
+ _request_timeout: Union[
2445
+ None,
2446
+ Annotated[StrictFloat, Field(gt=0)],
2447
+ Tuple[
2448
+ Annotated[StrictFloat, Field(gt=0)],
2449
+ Annotated[StrictFloat, Field(gt=0)]
2450
+ ]
2451
+ ] = None,
2452
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2453
+ _content_type: Optional[StrictStr] = None,
2454
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2455
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2456
+ ) -> RESTResponseType:
2457
+ """Retrieve a data access set's details
2458
+
2459
+ Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header.
2460
+
2461
+ :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required)
2462
+ :type data_access_set_id: str
2463
+ :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.
2464
+ :type target_tenant_id: str
2465
+ :param project_id: Optionally, specify a project in which to make the request.
2466
+ :type project_id: str
2467
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2468
+ :type non_versioned: bool
2469
+ :param _request_timeout: timeout setting for this request. If one
2470
+ number provided, it will be total request
2471
+ timeout. It can also be a pair (tuple) of
2472
+ (connection, read) timeouts.
2473
+ :type _request_timeout: int, tuple(int, int), optional
2474
+ :param _request_auth: set to override the auth_settings for an a single
2475
+ request; this effectively ignores the
2476
+ authentication in the spec for a single request.
2477
+ :type _request_auth: dict, optional
2478
+ :param _content_type: force content-type for the request.
2479
+ :type _content_type: str, Optional
2480
+ :param _headers: set to override the headers for a single
2481
+ request; this effectively ignores the headers
2482
+ in the spec for a single request.
2483
+ :type _headers: dict, optional
2484
+ :param _host_index: set to override the host_index for a single
2485
+ request; this effectively ignores the host_index
2486
+ in the spec for a single request.
2487
+ :type _host_index: int, optional
2488
+ :return: Returns the result object.
2489
+ """ # noqa: E501
2490
+
2491
+ _param = self._get_data_access_set_serialize(
2492
+ data_access_set_id=data_access_set_id,
2493
+ target_tenant_id=target_tenant_id,
2494
+ project_id=project_id,
2495
+ non_versioned=non_versioned,
2496
+ _request_auth=_request_auth,
2497
+ _content_type=_content_type,
2498
+ _headers=_headers,
2499
+ _host_index=_host_index
2500
+ )
2501
+
2502
+ _response_types_map: Dict[str, Optional[str]] = {
2503
+ '200': "DataAccessSetDTO",
2504
+ }
2505
+ response_data = self.api_client.call_api(
2506
+ *_param,
2507
+ _request_timeout=_request_timeout
2508
+ )
2509
+ return response_data.response
2510
+
2511
+
2512
+ def _get_data_access_set_serialize(
2513
+ self,
2514
+ data_access_set_id,
2515
+ target_tenant_id,
2516
+ project_id,
2517
+ non_versioned,
2518
+ _request_auth,
2519
+ _content_type,
2520
+ _headers,
2521
+ _host_index,
2522
+ ) -> RequestSerialized:
2523
+
2524
+ _host = None
2525
+
2526
+ _collection_formats: Dict[str, str] = {
2527
+ }
2528
+
2529
+ _path_params: Dict[str, str] = {}
2530
+ _query_params: List[Tuple[str, str]] = []
2531
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2532
+ _form_params: List[Tuple[str, str]] = []
2533
+ _files: Dict[
2534
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2535
+ ] = {}
2536
+ _body_params: Optional[bytes] = None
2537
+
2538
+ # process the path parameters
2539
+ if data_access_set_id is not None:
2540
+ _path_params['dataAccessSetId'] = data_access_set_id
2541
+ # process the query parameters
2542
+ # process the header parameters
2543
+ if target_tenant_id is not None:
2544
+ _header_params['TargetTenantID'] = target_tenant_id
2545
+ if project_id is not None:
2546
+ _header_params['ProjectID'] = project_id
2547
+ if non_versioned is not None:
2548
+ _header_params['NonVersioned'] = non_versioned
2549
+ # process the form parameters
2550
+ # process the body parameter
2551
+
2552
+
2553
+ # set the HTTP header `Accept`
2554
+ if 'Accept' not in _header_params:
2555
+ _header_params['Accept'] = self.api_client.select_header_accept(
2556
+ [
2557
+ 'application/json'
2558
+ ]
2559
+ )
2560
+
2561
+
2562
+ # authentication setting
2563
+ _auth_settings: List[str] = [
2564
+ 'CookieAuth',
2565
+ 'ApiKeyAuth',
2566
+ 'OAuth2Auth',
2567
+ 'OAuth2Auth',
2568
+ 'BearerAuth'
2569
+ ]
2570
+
2571
+ return self.api_client.param_serialize(
2572
+ method='GET',
2573
+ resource_path='/v1/admin/data-access-sets/{dataAccessSetId}',
2574
+ path_params=_path_params,
2575
+ query_params=_query_params,
2576
+ header_params=_header_params,
2577
+ body=_body_params,
2578
+ post_params=_form_params,
2579
+ files=_files,
2580
+ auth_settings=_auth_settings,
2581
+ collection_formats=_collection_formats,
2582
+ _host=_host,
2583
+ _request_auth=_request_auth
2584
+ )
2585
+
2586
+
2587
+
2588
+
2589
+ @validate_call
2590
+ def get_data_access_sets(
2591
+ self,
2592
+ analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None,
2593
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None,
2594
+ limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None,
2595
+ 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,
2596
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2597
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2598
+ _request_timeout: Union[
2599
+ None,
2600
+ Annotated[StrictFloat, Field(gt=0)],
2601
+ Tuple[
2602
+ Annotated[StrictFloat, Field(gt=0)],
2603
+ Annotated[StrictFloat, Field(gt=0)]
2604
+ ]
2605
+ ] = None,
2606
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2607
+ _content_type: Optional[StrictStr] = None,
2608
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2609
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2610
+ ) -> GetDataAccessSetsAPIResponseDTO:
2611
+ """Retrieve a list of all data access sets
2612
+
2613
+ Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number.
2614
+
2615
+ :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.
2616
+ :type analytic_object_id: str
2617
+ :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).
2618
+ :type var_with: List[str]
2619
+ :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000.
2620
+ :type limit: int
2621
+ :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.
2622
+ :type target_tenant_id: str
2623
+ :param project_id: Optionally, specify a project in which to make the request.
2624
+ :type project_id: str
2625
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2626
+ :type non_versioned: bool
2627
+ :param _request_timeout: timeout setting for this request. If one
2628
+ number provided, it will be total request
2629
+ timeout. It can also be a pair (tuple) of
2630
+ (connection, read) timeouts.
2631
+ :type _request_timeout: int, tuple(int, int), optional
2632
+ :param _request_auth: set to override the auth_settings for an a single
2633
+ request; this effectively ignores the
2634
+ authentication in the spec for a single request.
2635
+ :type _request_auth: dict, optional
2636
+ :param _content_type: force content-type for the request.
2637
+ :type _content_type: str, Optional
2638
+ :param _headers: set to override the headers for a single
2639
+ request; this effectively ignores the headers
2640
+ in the spec for a single request.
2641
+ :type _headers: dict, optional
2642
+ :param _host_index: set to override the host_index for a single
2643
+ request; this effectively ignores the host_index
2644
+ in the spec for a single request.
2645
+ :type _host_index: int, optional
2646
+ :return: Returns the result object.
2647
+ """ # noqa: E501
2648
+
2649
+ _param = self._get_data_access_sets_serialize(
2650
+ analytic_object_id=analytic_object_id,
2651
+ var_with=var_with,
2652
+ limit=limit,
2653
+ target_tenant_id=target_tenant_id,
2654
+ project_id=project_id,
2655
+ non_versioned=non_versioned,
2656
+ _request_auth=_request_auth,
2657
+ _content_type=_content_type,
2658
+ _headers=_headers,
2659
+ _host_index=_host_index
2660
+ )
2661
+
2662
+ _response_types_map: Dict[str, Optional[str]] = {
2663
+ '200': "GetDataAccessSetsAPIResponseDTO",
2664
+ }
2665
+ response_data = self.api_client.call_api(
2666
+ *_param,
2667
+ _request_timeout=_request_timeout
2668
+ )
2669
+ response_data.read()
2670
+ return self.api_client.response_deserialize(
2671
+ response_data=response_data,
2672
+ response_types_map=_response_types_map,
2673
+ ).data
2674
+
2675
+
2676
+ @validate_call
2677
+ def get_data_access_sets_with_http_info(
2678
+ self,
2679
+ analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None,
2680
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None,
2681
+ limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None,
2682
+ 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,
2683
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2684
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2685
+ _request_timeout: Union[
2686
+ None,
2687
+ Annotated[StrictFloat, Field(gt=0)],
2688
+ Tuple[
2689
+ Annotated[StrictFloat, Field(gt=0)],
2690
+ Annotated[StrictFloat, Field(gt=0)]
2691
+ ]
2692
+ ] = None,
2693
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2694
+ _content_type: Optional[StrictStr] = None,
2695
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2696
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2697
+ ) -> ApiResponse[GetDataAccessSetsAPIResponseDTO]:
2698
+ """Retrieve a list of all data access sets
2699
+
2700
+ Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number.
2701
+
2702
+ :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.
2703
+ :type analytic_object_id: str
2704
+ :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).
2705
+ :type var_with: List[str]
2706
+ :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000.
2707
+ :type limit: int
2708
+ :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.
2709
+ :type target_tenant_id: str
2710
+ :param project_id: Optionally, specify a project in which to make the request.
2711
+ :type project_id: str
2712
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2713
+ :type non_versioned: bool
2714
+ :param _request_timeout: timeout setting for this request. If one
2715
+ number provided, it will be total request
2716
+ timeout. It can also be a pair (tuple) of
2717
+ (connection, read) timeouts.
2718
+ :type _request_timeout: int, tuple(int, int), optional
2719
+ :param _request_auth: set to override the auth_settings for an a single
2720
+ request; this effectively ignores the
2721
+ authentication in the spec for a single request.
2722
+ :type _request_auth: dict, optional
2723
+ :param _content_type: force content-type for the request.
2724
+ :type _content_type: str, Optional
2725
+ :param _headers: set to override the headers for a single
2726
+ request; this effectively ignores the headers
2727
+ in the spec for a single request.
2728
+ :type _headers: dict, optional
2729
+ :param _host_index: set to override the host_index for a single
2730
+ request; this effectively ignores the host_index
2731
+ in the spec for a single request.
2732
+ :type _host_index: int, optional
2733
+ :return: Returns the result object.
2734
+ """ # noqa: E501
2735
+
2736
+ _param = self._get_data_access_sets_serialize(
2737
+ analytic_object_id=analytic_object_id,
2738
+ var_with=var_with,
2739
+ limit=limit,
2740
+ target_tenant_id=target_tenant_id,
2741
+ project_id=project_id,
2742
+ non_versioned=non_versioned,
2743
+ _request_auth=_request_auth,
2744
+ _content_type=_content_type,
2745
+ _headers=_headers,
2746
+ _host_index=_host_index
2747
+ )
2748
+
2749
+ _response_types_map: Dict[str, Optional[str]] = {
2750
+ '200': "GetDataAccessSetsAPIResponseDTO",
2751
+ }
2752
+ response_data = self.api_client.call_api(
2753
+ *_param,
2754
+ _request_timeout=_request_timeout
2755
+ )
2756
+ response_data.read()
2757
+ return self.api_client.response_deserialize(
2758
+ response_data=response_data,
2759
+ response_types_map=_response_types_map,
2760
+ )
2761
+
2762
+
2763
+ @validate_call
2764
+ def get_data_access_sets_without_preload_content(
2765
+ self,
2766
+ analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None,
2767
+ var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None,
2768
+ limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None,
2769
+ 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,
2770
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2771
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
2772
+ _request_timeout: Union[
2773
+ None,
2774
+ Annotated[StrictFloat, Field(gt=0)],
2775
+ Tuple[
2776
+ Annotated[StrictFloat, Field(gt=0)],
2777
+ Annotated[StrictFloat, Field(gt=0)]
2778
+ ]
2779
+ ] = None,
2780
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2781
+ _content_type: Optional[StrictStr] = None,
2782
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2783
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2784
+ ) -> RESTResponseType:
2785
+ """Retrieve a list of all data access sets
2786
+
2787
+ Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number.
2788
+
2789
+ :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.
2790
+ :type analytic_object_id: str
2791
+ :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).
2792
+ :type var_with: List[str]
2793
+ :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000.
2794
+ :type limit: int
2795
+ :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.
2796
+ :type target_tenant_id: str
2797
+ :param project_id: Optionally, specify a project in which to make the request.
2798
+ :type project_id: str
2799
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
2800
+ :type non_versioned: bool
2801
+ :param _request_timeout: timeout setting for this request. If one
2802
+ number provided, it will be total request
2803
+ timeout. It can also be a pair (tuple) of
2804
+ (connection, read) timeouts.
2805
+ :type _request_timeout: int, tuple(int, int), optional
2806
+ :param _request_auth: set to override the auth_settings for an a single
2807
+ request; this effectively ignores the
2808
+ authentication in the spec for a single request.
2809
+ :type _request_auth: dict, optional
2810
+ :param _content_type: force content-type for the request.
2811
+ :type _content_type: str, Optional
2812
+ :param _headers: set to override the headers for a single
2813
+ request; this effectively ignores the headers
2814
+ in the spec for a single request.
2815
+ :type _headers: dict, optional
2816
+ :param _host_index: set to override the host_index for a single
2817
+ request; this effectively ignores the host_index
2818
+ in the spec for a single request.
2819
+ :type _host_index: int, optional
2820
+ :return: Returns the result object.
2821
+ """ # noqa: E501
2822
+
2823
+ _param = self._get_data_access_sets_serialize(
2824
+ analytic_object_id=analytic_object_id,
2825
+ var_with=var_with,
2826
+ limit=limit,
2827
+ target_tenant_id=target_tenant_id,
2828
+ project_id=project_id,
2829
+ non_versioned=non_versioned,
2830
+ _request_auth=_request_auth,
2831
+ _content_type=_content_type,
2832
+ _headers=_headers,
2833
+ _host_index=_host_index
2834
+ )
2835
+
2836
+ _response_types_map: Dict[str, Optional[str]] = {
2837
+ '200': "GetDataAccessSetsAPIResponseDTO",
2838
+ }
2839
+ response_data = self.api_client.call_api(
2840
+ *_param,
2841
+ _request_timeout=_request_timeout
2842
+ )
2843
+ return response_data.response
2844
+
2845
+
2846
+ def _get_data_access_sets_serialize(
2847
+ self,
2848
+ analytic_object_id,
2849
+ var_with,
2850
+ limit,
2851
+ target_tenant_id,
2852
+ project_id,
2853
+ non_versioned,
2854
+ _request_auth,
2855
+ _content_type,
2856
+ _headers,
2857
+ _host_index,
2858
+ ) -> RequestSerialized:
2859
+
2860
+ _host = None
2861
+
2862
+ _collection_formats: Dict[str, str] = {
2863
+ 'with': 'multi',
2864
+ }
2865
+
2866
+ _path_params: Dict[str, str] = {}
2867
+ _query_params: List[Tuple[str, str]] = []
2868
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2869
+ _form_params: List[Tuple[str, str]] = []
2870
+ _files: Dict[
2871
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2872
+ ] = {}
2873
+ _body_params: Optional[bytes] = None
2874
+
2875
+ # process the path parameters
2876
+ # process the query parameters
2877
+ if analytic_object_id is not None:
2878
+
2879
+ _query_params.append(('analyticObjectId', analytic_object_id))
2880
+
2881
+ if var_with is not None:
2882
+
2883
+ _query_params.append(('with', var_with))
2884
+
2885
+ if limit is not None:
2886
+
2887
+ _query_params.append(('limit', limit))
2888
+
2889
+ # process the header parameters
2890
+ if target_tenant_id is not None:
2891
+ _header_params['TargetTenantID'] = target_tenant_id
2892
+ if project_id is not None:
2893
+ _header_params['ProjectID'] = project_id
2894
+ if non_versioned is not None:
2895
+ _header_params['NonVersioned'] = non_versioned
2896
+ # process the form parameters
2897
+ # process the body parameter
2898
+
2899
+
2900
+ # set the HTTP header `Accept`
2901
+ if 'Accept' not in _header_params:
2902
+ _header_params['Accept'] = self.api_client.select_header_accept(
2903
+ [
2904
+ 'application/json'
2905
+ ]
2906
+ )
2907
+
2908
+
2909
+ # authentication setting
2910
+ _auth_settings: List[str] = [
2911
+ 'CookieAuth',
2912
+ 'ApiKeyAuth',
2913
+ 'OAuth2Auth',
2914
+ 'OAuth2Auth',
2915
+ 'BearerAuth'
2916
+ ]
2917
+
2918
+ return self.api_client.param_serialize(
2919
+ method='GET',
2920
+ resource_path='/v1/admin/data-access-sets',
2921
+ path_params=_path_params,
2922
+ query_params=_query_params,
2923
+ header_params=_header_params,
2924
+ body=_body_params,
2925
+ post_params=_form_params,
2926
+ files=_files,
2927
+ auth_settings=_auth_settings,
2928
+ collection_formats=_collection_formats,
2929
+ _host=_host,
2930
+ _request_auth=_request_auth
2931
+ )
2932
+
2933
+
2934
+
2935
+
2936
+ @validate_call
2937
+ def get_data_security_objects(
2938
+ self,
2939
+ id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None,
2940
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None,
2941
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None,
2942
+ 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,
2943
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
2944
+ _request_timeout: Union[
2945
+ None,
2946
+ Annotated[StrictFloat, Field(gt=0)],
2947
+ Tuple[
2948
+ Annotated[StrictFloat, Field(gt=0)],
2949
+ Annotated[StrictFloat, Field(gt=0)]
2950
+ ]
2951
+ ] = None,
2952
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2953
+ _content_type: Optional[StrictStr] = None,
2954
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2955
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2956
+ ) -> GetDataSecurityObjectsAPIResponseDTO:
2957
+ """Retrieve a list of data security objects
2958
+
2959
+ Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header.
2960
+
2961
+ :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.
2962
+ :type id: List[str]
2963
+ :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.
2964
+ :type include_details: bool
2965
+ :param tenant_code: Specify the tenant to retrieve data security objects from.
2966
+ :type tenant_code: str
2967
+ :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.
2968
+ :type target_tenant_id: str
2969
+ :param project_id: Optionally, specify a project in which to make the request.
2970
+ :type project_id: str
2971
+ :param _request_timeout: timeout setting for this request. If one
2972
+ number provided, it will be total request
2973
+ timeout. It can also be a pair (tuple) of
2974
+ (connection, read) timeouts.
2975
+ :type _request_timeout: int, tuple(int, int), optional
2976
+ :param _request_auth: set to override the auth_settings for an a single
2977
+ request; this effectively ignores the
2978
+ authentication in the spec for a single request.
2979
+ :type _request_auth: dict, optional
2980
+ :param _content_type: force content-type for the request.
2981
+ :type _content_type: str, Optional
2982
+ :param _headers: set to override the headers for a single
2983
+ request; this effectively ignores the headers
2984
+ in the spec for a single request.
2985
+ :type _headers: dict, optional
2986
+ :param _host_index: set to override the host_index for a single
2987
+ request; this effectively ignores the host_index
2988
+ in the spec for a single request.
2989
+ :type _host_index: int, optional
2990
+ :return: Returns the result object.
2991
+ """ # noqa: E501
2992
+
2993
+ _param = self._get_data_security_objects_serialize(
2994
+ id=id,
2995
+ include_details=include_details,
2996
+ tenant_code=tenant_code,
2997
+ target_tenant_id=target_tenant_id,
2998
+ project_id=project_id,
2999
+ _request_auth=_request_auth,
3000
+ _content_type=_content_type,
3001
+ _headers=_headers,
3002
+ _host_index=_host_index
3003
+ )
3004
+
3005
+ _response_types_map: Dict[str, Optional[str]] = {
3006
+ '200': "GetDataSecurityObjectsAPIResponseDTO",
3007
+ }
3008
+ response_data = self.api_client.call_api(
3009
+ *_param,
3010
+ _request_timeout=_request_timeout
3011
+ )
3012
+ response_data.read()
3013
+ return self.api_client.response_deserialize(
3014
+ response_data=response_data,
3015
+ response_types_map=_response_types_map,
3016
+ ).data
3017
+
3018
+
3019
+ @validate_call
3020
+ def get_data_security_objects_with_http_info(
3021
+ self,
3022
+ id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None,
3023
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None,
3024
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None,
3025
+ 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,
3026
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3027
+ _request_timeout: Union[
3028
+ None,
3029
+ Annotated[StrictFloat, Field(gt=0)],
3030
+ Tuple[
3031
+ Annotated[StrictFloat, Field(gt=0)],
3032
+ Annotated[StrictFloat, Field(gt=0)]
3033
+ ]
3034
+ ] = None,
3035
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3036
+ _content_type: Optional[StrictStr] = None,
3037
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3038
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3039
+ ) -> ApiResponse[GetDataSecurityObjectsAPIResponseDTO]:
3040
+ """Retrieve a list of data security objects
3041
+
3042
+ Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header.
3043
+
3044
+ :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.
3045
+ :type id: List[str]
3046
+ :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.
3047
+ :type include_details: bool
3048
+ :param tenant_code: Specify the tenant to retrieve data security objects from.
3049
+ :type tenant_code: str
3050
+ :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.
3051
+ :type target_tenant_id: str
3052
+ :param project_id: Optionally, specify a project in which to make the request.
3053
+ :type project_id: str
3054
+ :param _request_timeout: timeout setting for this request. If one
3055
+ number provided, it will be total request
3056
+ timeout. It can also be a pair (tuple) of
3057
+ (connection, read) timeouts.
3058
+ :type _request_timeout: int, tuple(int, int), optional
3059
+ :param _request_auth: set to override the auth_settings for an a single
3060
+ request; this effectively ignores the
3061
+ authentication in the spec for a single request.
3062
+ :type _request_auth: dict, optional
3063
+ :param _content_type: force content-type for the request.
3064
+ :type _content_type: str, Optional
3065
+ :param _headers: set to override the headers for a single
3066
+ request; this effectively ignores the headers
3067
+ in the spec for a single request.
3068
+ :type _headers: dict, optional
3069
+ :param _host_index: set to override the host_index for a single
3070
+ request; this effectively ignores the host_index
3071
+ in the spec for a single request.
3072
+ :type _host_index: int, optional
3073
+ :return: Returns the result object.
3074
+ """ # noqa: E501
3075
+
3076
+ _param = self._get_data_security_objects_serialize(
3077
+ id=id,
3078
+ include_details=include_details,
3079
+ tenant_code=tenant_code,
3080
+ target_tenant_id=target_tenant_id,
3081
+ project_id=project_id,
3082
+ _request_auth=_request_auth,
3083
+ _content_type=_content_type,
3084
+ _headers=_headers,
3085
+ _host_index=_host_index
3086
+ )
3087
+
3088
+ _response_types_map: Dict[str, Optional[str]] = {
3089
+ '200': "GetDataSecurityObjectsAPIResponseDTO",
3090
+ }
3091
+ response_data = self.api_client.call_api(
3092
+ *_param,
3093
+ _request_timeout=_request_timeout
3094
+ )
3095
+ response_data.read()
3096
+ return self.api_client.response_deserialize(
3097
+ response_data=response_data,
3098
+ response_types_map=_response_types_map,
3099
+ )
3100
+
3101
+
3102
+ @validate_call
3103
+ def get_data_security_objects_without_preload_content(
3104
+ self,
3105
+ id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None,
3106
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None,
3107
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None,
3108
+ 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,
3109
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3110
+ _request_timeout: Union[
3111
+ None,
3112
+ Annotated[StrictFloat, Field(gt=0)],
3113
+ Tuple[
3114
+ Annotated[StrictFloat, Field(gt=0)],
3115
+ Annotated[StrictFloat, Field(gt=0)]
3116
+ ]
3117
+ ] = None,
3118
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3119
+ _content_type: Optional[StrictStr] = None,
3120
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3121
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3122
+ ) -> RESTResponseType:
3123
+ """Retrieve a list of data security objects
3124
+
3125
+ Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header.
3126
+
3127
+ :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.
3128
+ :type id: List[str]
3129
+ :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.
3130
+ :type include_details: bool
3131
+ :param tenant_code: Specify the tenant to retrieve data security objects from.
3132
+ :type tenant_code: str
3133
+ :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.
3134
+ :type target_tenant_id: str
3135
+ :param project_id: Optionally, specify a project in which to make the request.
3136
+ :type project_id: str
3137
+ :param _request_timeout: timeout setting for this request. If one
3138
+ number provided, it will be total request
3139
+ timeout. It can also be a pair (tuple) of
3140
+ (connection, read) timeouts.
3141
+ :type _request_timeout: int, tuple(int, int), optional
3142
+ :param _request_auth: set to override the auth_settings for an a single
3143
+ request; this effectively ignores the
3144
+ authentication in the spec for a single request.
3145
+ :type _request_auth: dict, optional
3146
+ :param _content_type: force content-type for the request.
3147
+ :type _content_type: str, Optional
3148
+ :param _headers: set to override the headers for a single
3149
+ request; this effectively ignores the headers
3150
+ in the spec for a single request.
3151
+ :type _headers: dict, optional
3152
+ :param _host_index: set to override the host_index for a single
3153
+ request; this effectively ignores the host_index
3154
+ in the spec for a single request.
3155
+ :type _host_index: int, optional
3156
+ :return: Returns the result object.
3157
+ """ # noqa: E501
3158
+
3159
+ _param = self._get_data_security_objects_serialize(
3160
+ id=id,
3161
+ include_details=include_details,
3162
+ tenant_code=tenant_code,
3163
+ target_tenant_id=target_tenant_id,
3164
+ project_id=project_id,
3165
+ _request_auth=_request_auth,
3166
+ _content_type=_content_type,
3167
+ _headers=_headers,
3168
+ _host_index=_host_index
3169
+ )
3170
+
3171
+ _response_types_map: Dict[str, Optional[str]] = {
3172
+ '200': "GetDataSecurityObjectsAPIResponseDTO",
3173
+ }
3174
+ response_data = self.api_client.call_api(
3175
+ *_param,
3176
+ _request_timeout=_request_timeout
3177
+ )
3178
+ return response_data.response
3179
+
3180
+
3181
+ def _get_data_security_objects_serialize(
3182
+ self,
3183
+ id,
3184
+ include_details,
3185
+ tenant_code,
3186
+ target_tenant_id,
3187
+ project_id,
3188
+ _request_auth,
3189
+ _content_type,
3190
+ _headers,
3191
+ _host_index,
3192
+ ) -> RequestSerialized:
3193
+
3194
+ _host = None
3195
+
3196
+ _collection_formats: Dict[str, str] = {
3197
+ 'id': 'multi',
3198
+ }
3199
+
3200
+ _path_params: Dict[str, str] = {}
3201
+ _query_params: List[Tuple[str, str]] = []
3202
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3203
+ _form_params: List[Tuple[str, str]] = []
3204
+ _files: Dict[
3205
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3206
+ ] = {}
3207
+ _body_params: Optional[bytes] = None
3208
+
3209
+ # process the path parameters
3210
+ # process the query parameters
3211
+ if id is not None:
3212
+
3213
+ _query_params.append(('id', id))
3214
+
3215
+ if include_details is not None:
3216
+
3217
+ _query_params.append(('includeDetails', include_details))
3218
+
3219
+ if tenant_code is not None:
3220
+
3221
+ _query_params.append(('tenantCode', tenant_code))
3222
+
3223
+ # process the header parameters
3224
+ if target_tenant_id is not None:
3225
+ _header_params['TargetTenantID'] = target_tenant_id
3226
+ if project_id is not None:
3227
+ _header_params['ProjectID'] = project_id
3228
+ # process the form parameters
3229
+ # process the body parameter
3230
+
3231
+
3232
+ # set the HTTP header `Accept`
3233
+ if 'Accept' not in _header_params:
3234
+ _header_params['Accept'] = self.api_client.select_header_accept(
3235
+ [
3236
+ 'application/json'
3237
+ ]
3238
+ )
3239
+
3240
+
3241
+ # authentication setting
3242
+ _auth_settings: List[str] = [
3243
+ 'CookieAuth',
3244
+ 'ApiKeyAuth',
3245
+ 'OAuth2Auth',
3246
+ 'OAuth2Auth',
3247
+ 'BearerAuth'
3248
+ ]
3249
+
3250
+ return self.api_client.param_serialize(
3251
+ method='GET',
3252
+ resource_path='/v1/admin/data-security-objects',
3253
+ path_params=_path_params,
3254
+ query_params=_query_params,
3255
+ header_params=_header_params,
3256
+ body=_body_params,
3257
+ post_params=_form_params,
3258
+ files=_files,
3259
+ auth_settings=_auth_settings,
3260
+ collection_formats=_collection_formats,
3261
+ _host=_host,
3262
+ _request_auth=_request_auth
3263
+ )
3264
+
3265
+
3266
+
3267
+
3268
+ @validate_call
3269
+ def get_permission(
3270
+ self,
3271
+ permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")],
3272
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None,
3273
+ include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3274
+ 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,
3275
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3276
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3277
+ _request_timeout: Union[
3278
+ None,
3279
+ Annotated[StrictFloat, Field(gt=0)],
3280
+ Tuple[
3281
+ Annotated[StrictFloat, Field(gt=0)],
3282
+ Annotated[StrictFloat, Field(gt=0)]
3283
+ ]
3284
+ ] = None,
3285
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3286
+ _content_type: Optional[StrictStr] = None,
3287
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3288
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3289
+ ) -> PermissionDTO:
3290
+ """Retrieve a permission's details
3291
+
3292
+ Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header.
3293
+
3294
+ :param permission_id: The unique identifier of the permission you want to retrieve. (required)
3295
+ :type permission_id: str
3296
+ :param tenant_code: Specify the tenant to retrieve a permission from.
3297
+ :type tenant_code: str
3298
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3299
+ :type include_details_with_status: str
3300
+ :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.
3301
+ :type target_tenant_id: str
3302
+ :param project_id: Optionally, specify a project in which to make the request.
3303
+ :type project_id: str
3304
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3305
+ :type non_versioned: bool
3306
+ :param _request_timeout: timeout setting for this request. If one
3307
+ number provided, it will be total request
3308
+ timeout. It can also be a pair (tuple) of
3309
+ (connection, read) timeouts.
3310
+ :type _request_timeout: int, tuple(int, int), optional
3311
+ :param _request_auth: set to override the auth_settings for an a single
3312
+ request; this effectively ignores the
3313
+ authentication in the spec for a single request.
3314
+ :type _request_auth: dict, optional
3315
+ :param _content_type: force content-type for the request.
3316
+ :type _content_type: str, Optional
3317
+ :param _headers: set to override the headers for a single
3318
+ request; this effectively ignores the headers
3319
+ in the spec for a single request.
3320
+ :type _headers: dict, optional
3321
+ :param _host_index: set to override the host_index for a single
3322
+ request; this effectively ignores the host_index
3323
+ in the spec for a single request.
3324
+ :type _host_index: int, optional
3325
+ :return: Returns the result object.
3326
+ """ # noqa: E501
3327
+
3328
+ _param = self._get_permission_serialize(
3329
+ permission_id=permission_id,
3330
+ tenant_code=tenant_code,
3331
+ include_details_with_status=include_details_with_status,
3332
+ target_tenant_id=target_tenant_id,
3333
+ project_id=project_id,
3334
+ non_versioned=non_versioned,
3335
+ _request_auth=_request_auth,
3336
+ _content_type=_content_type,
3337
+ _headers=_headers,
3338
+ _host_index=_host_index
3339
+ )
3340
+
3341
+ _response_types_map: Dict[str, Optional[str]] = {
3342
+ '200': "PermissionDTO",
3343
+ }
3344
+ response_data = self.api_client.call_api(
3345
+ *_param,
3346
+ _request_timeout=_request_timeout
3347
+ )
3348
+ response_data.read()
3349
+ return self.api_client.response_deserialize(
3350
+ response_data=response_data,
3351
+ response_types_map=_response_types_map,
3352
+ ).data
3353
+
3354
+
3355
+ @validate_call
3356
+ def get_permission_with_http_info(
3357
+ self,
3358
+ permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")],
3359
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None,
3360
+ include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3361
+ 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,
3362
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3363
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3364
+ _request_timeout: Union[
3365
+ None,
3366
+ Annotated[StrictFloat, Field(gt=0)],
3367
+ Tuple[
3368
+ Annotated[StrictFloat, Field(gt=0)],
3369
+ Annotated[StrictFloat, Field(gt=0)]
3370
+ ]
3371
+ ] = None,
3372
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3373
+ _content_type: Optional[StrictStr] = None,
3374
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3375
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3376
+ ) -> ApiResponse[PermissionDTO]:
3377
+ """Retrieve a permission's details
3378
+
3379
+ Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header.
3380
+
3381
+ :param permission_id: The unique identifier of the permission you want to retrieve. (required)
3382
+ :type permission_id: str
3383
+ :param tenant_code: Specify the tenant to retrieve a permission from.
3384
+ :type tenant_code: str
3385
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3386
+ :type include_details_with_status: str
3387
+ :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.
3388
+ :type target_tenant_id: str
3389
+ :param project_id: Optionally, specify a project in which to make the request.
3390
+ :type project_id: str
3391
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3392
+ :type non_versioned: bool
3393
+ :param _request_timeout: timeout setting for this request. If one
3394
+ number provided, it will be total request
3395
+ timeout. It can also be a pair (tuple) of
3396
+ (connection, read) timeouts.
3397
+ :type _request_timeout: int, tuple(int, int), optional
3398
+ :param _request_auth: set to override the auth_settings for an a single
3399
+ request; this effectively ignores the
3400
+ authentication in the spec for a single request.
3401
+ :type _request_auth: dict, optional
3402
+ :param _content_type: force content-type for the request.
3403
+ :type _content_type: str, Optional
3404
+ :param _headers: set to override the headers for a single
3405
+ request; this effectively ignores the headers
3406
+ in the spec for a single request.
3407
+ :type _headers: dict, optional
3408
+ :param _host_index: set to override the host_index for a single
3409
+ request; this effectively ignores the host_index
3410
+ in the spec for a single request.
3411
+ :type _host_index: int, optional
3412
+ :return: Returns the result object.
3413
+ """ # noqa: E501
3414
+
3415
+ _param = self._get_permission_serialize(
3416
+ permission_id=permission_id,
3417
+ tenant_code=tenant_code,
3418
+ include_details_with_status=include_details_with_status,
3419
+ target_tenant_id=target_tenant_id,
3420
+ project_id=project_id,
3421
+ non_versioned=non_versioned,
3422
+ _request_auth=_request_auth,
3423
+ _content_type=_content_type,
3424
+ _headers=_headers,
3425
+ _host_index=_host_index
3426
+ )
3427
+
3428
+ _response_types_map: Dict[str, Optional[str]] = {
3429
+ '200': "PermissionDTO",
3430
+ }
3431
+ response_data = self.api_client.call_api(
3432
+ *_param,
3433
+ _request_timeout=_request_timeout
3434
+ )
3435
+ response_data.read()
3436
+ return self.api_client.response_deserialize(
3437
+ response_data=response_data,
3438
+ response_types_map=_response_types_map,
3439
+ )
3440
+
3441
+
3442
+ @validate_call
3443
+ def get_permission_without_preload_content(
3444
+ self,
3445
+ permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")],
3446
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None,
3447
+ include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3448
+ 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,
3449
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3450
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3451
+ _request_timeout: Union[
3452
+ None,
3453
+ Annotated[StrictFloat, Field(gt=0)],
3454
+ Tuple[
3455
+ Annotated[StrictFloat, Field(gt=0)],
3456
+ Annotated[StrictFloat, Field(gt=0)]
3457
+ ]
3458
+ ] = None,
3459
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3460
+ _content_type: Optional[StrictStr] = None,
3461
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3462
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3463
+ ) -> RESTResponseType:
3464
+ """Retrieve a permission's details
3465
+
3466
+ Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header.
3467
+
3468
+ :param permission_id: The unique identifier of the permission you want to retrieve. (required)
3469
+ :type permission_id: str
3470
+ :param tenant_code: Specify the tenant to retrieve a permission from.
3471
+ :type tenant_code: str
3472
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3473
+ :type include_details_with_status: str
3474
+ :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.
3475
+ :type target_tenant_id: str
3476
+ :param project_id: Optionally, specify a project in which to make the request.
3477
+ :type project_id: str
3478
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3479
+ :type non_versioned: bool
3480
+ :param _request_timeout: timeout setting for this request. If one
3481
+ number provided, it will be total request
3482
+ timeout. It can also be a pair (tuple) of
3483
+ (connection, read) timeouts.
3484
+ :type _request_timeout: int, tuple(int, int), optional
3485
+ :param _request_auth: set to override the auth_settings for an a single
3486
+ request; this effectively ignores the
3487
+ authentication in the spec for a single request.
3488
+ :type _request_auth: dict, optional
3489
+ :param _content_type: force content-type for the request.
3490
+ :type _content_type: str, Optional
3491
+ :param _headers: set to override the headers for a single
3492
+ request; this effectively ignores the headers
3493
+ in the spec for a single request.
3494
+ :type _headers: dict, optional
3495
+ :param _host_index: set to override the host_index for a single
3496
+ request; this effectively ignores the host_index
3497
+ in the spec for a single request.
3498
+ :type _host_index: int, optional
3499
+ :return: Returns the result object.
3500
+ """ # noqa: E501
3501
+
3502
+ _param = self._get_permission_serialize(
3503
+ permission_id=permission_id,
3504
+ tenant_code=tenant_code,
3505
+ include_details_with_status=include_details_with_status,
3506
+ target_tenant_id=target_tenant_id,
3507
+ project_id=project_id,
3508
+ non_versioned=non_versioned,
3509
+ _request_auth=_request_auth,
3510
+ _content_type=_content_type,
3511
+ _headers=_headers,
3512
+ _host_index=_host_index
3513
+ )
3514
+
3515
+ _response_types_map: Dict[str, Optional[str]] = {
3516
+ '200': "PermissionDTO",
3517
+ }
3518
+ response_data = self.api_client.call_api(
3519
+ *_param,
3520
+ _request_timeout=_request_timeout
3521
+ )
3522
+ return response_data.response
3523
+
3524
+
3525
+ def _get_permission_serialize(
3526
+ self,
3527
+ permission_id,
3528
+ tenant_code,
3529
+ include_details_with_status,
3530
+ target_tenant_id,
3531
+ project_id,
3532
+ non_versioned,
3533
+ _request_auth,
3534
+ _content_type,
3535
+ _headers,
3536
+ _host_index,
3537
+ ) -> RequestSerialized:
3538
+
3539
+ _host = None
3540
+
3541
+ _collection_formats: Dict[str, str] = {
3542
+ }
3543
+
3544
+ _path_params: Dict[str, str] = {}
3545
+ _query_params: List[Tuple[str, str]] = []
3546
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3547
+ _form_params: List[Tuple[str, str]] = []
3548
+ _files: Dict[
3549
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3550
+ ] = {}
3551
+ _body_params: Optional[bytes] = None
3552
+
3553
+ # process the path parameters
3554
+ if permission_id is not None:
3555
+ _path_params['permissionId'] = permission_id
3556
+ # process the query parameters
3557
+ if tenant_code is not None:
3558
+
3559
+ _query_params.append(('tenantCode', tenant_code))
3560
+
3561
+ if include_details_with_status is not None:
3562
+
3563
+ _query_params.append(('includeDetailsWithStatus', include_details_with_status))
3564
+
3565
+ # process the header parameters
3566
+ if target_tenant_id is not None:
3567
+ _header_params['TargetTenantID'] = target_tenant_id
3568
+ if project_id is not None:
3569
+ _header_params['ProjectID'] = project_id
3570
+ if non_versioned is not None:
3571
+ _header_params['NonVersioned'] = non_versioned
3572
+ # process the form parameters
3573
+ # process the body parameter
3574
+
3575
+
3576
+ # set the HTTP header `Accept`
3577
+ if 'Accept' not in _header_params:
3578
+ _header_params['Accept'] = self.api_client.select_header_accept(
3579
+ [
3580
+ 'application/json'
3581
+ ]
3582
+ )
3583
+
3584
+
3585
+ # authentication setting
3586
+ _auth_settings: List[str] = [
3587
+ 'CookieAuth',
3588
+ 'ApiKeyAuth',
3589
+ 'OAuth2Auth',
3590
+ 'OAuth2Auth',
3591
+ 'BearerAuth'
3592
+ ]
3593
+
3594
+ return self.api_client.param_serialize(
3595
+ method='GET',
3596
+ resource_path='/v1/admin/permissions/{permissionId}',
3597
+ path_params=_path_params,
3598
+ query_params=_query_params,
3599
+ header_params=_header_params,
3600
+ body=_body_params,
3601
+ post_params=_form_params,
3602
+ files=_files,
3603
+ auth_settings=_auth_settings,
3604
+ collection_formats=_collection_formats,
3605
+ _host=_host,
3606
+ _request_auth=_request_auth
3607
+ )
3608
+
3609
+
3610
+
3611
+
3612
+ @validate_call
3613
+ def get_permissions(
3614
+ self,
3615
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None,
3616
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None,
3617
+ include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3618
+ 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,
3619
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3620
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3621
+ _request_timeout: Union[
3622
+ None,
3623
+ Annotated[StrictFloat, Field(gt=0)],
3624
+ Tuple[
3625
+ Annotated[StrictFloat, Field(gt=0)],
3626
+ Annotated[StrictFloat, Field(gt=0)]
3627
+ ]
3628
+ ] = None,
3629
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3630
+ _content_type: Optional[StrictStr] = None,
3631
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3632
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3633
+ ) -> GetPermissionsAPIResponseDTO:
3634
+ """Retrieve a list of all permissions
3635
+
3636
+ Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header.
3637
+
3638
+ :param tenant_code: Specify the tenant to retrieve the permissions from.
3639
+ :type tenant_code: str
3640
+ :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.
3641
+ :type include_details: bool
3642
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3643
+ :type include_details_with_status: bool
3644
+ :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.
3645
+ :type target_tenant_id: str
3646
+ :param project_id: Optionally, specify a project in which to make the request.
3647
+ :type project_id: str
3648
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3649
+ :type non_versioned: bool
3650
+ :param _request_timeout: timeout setting for this request. If one
3651
+ number provided, it will be total request
3652
+ timeout. It can also be a pair (tuple) of
3653
+ (connection, read) timeouts.
3654
+ :type _request_timeout: int, tuple(int, int), optional
3655
+ :param _request_auth: set to override the auth_settings for an a single
3656
+ request; this effectively ignores the
3657
+ authentication in the spec for a single request.
3658
+ :type _request_auth: dict, optional
3659
+ :param _content_type: force content-type for the request.
3660
+ :type _content_type: str, Optional
3661
+ :param _headers: set to override the headers for a single
3662
+ request; this effectively ignores the headers
3663
+ in the spec for a single request.
3664
+ :type _headers: dict, optional
3665
+ :param _host_index: set to override the host_index for a single
3666
+ request; this effectively ignores the host_index
3667
+ in the spec for a single request.
3668
+ :type _host_index: int, optional
3669
+ :return: Returns the result object.
3670
+ """ # noqa: E501
3671
+
3672
+ _param = self._get_permissions_serialize(
3673
+ tenant_code=tenant_code,
3674
+ include_details=include_details,
3675
+ include_details_with_status=include_details_with_status,
3676
+ target_tenant_id=target_tenant_id,
3677
+ project_id=project_id,
3678
+ non_versioned=non_versioned,
3679
+ _request_auth=_request_auth,
3680
+ _content_type=_content_type,
3681
+ _headers=_headers,
3682
+ _host_index=_host_index
3683
+ )
3684
+
3685
+ _response_types_map: Dict[str, Optional[str]] = {
3686
+ '200': "GetPermissionsAPIResponseDTO",
3687
+ }
3688
+ response_data = self.api_client.call_api(
3689
+ *_param,
3690
+ _request_timeout=_request_timeout
3691
+ )
3692
+ response_data.read()
3693
+ return self.api_client.response_deserialize(
3694
+ response_data=response_data,
3695
+ response_types_map=_response_types_map,
3696
+ ).data
3697
+
3698
+
3699
+ @validate_call
3700
+ def get_permissions_with_http_info(
3701
+ self,
3702
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None,
3703
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None,
3704
+ include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3705
+ 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,
3706
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3707
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3708
+ _request_timeout: Union[
3709
+ None,
3710
+ Annotated[StrictFloat, Field(gt=0)],
3711
+ Tuple[
3712
+ Annotated[StrictFloat, Field(gt=0)],
3713
+ Annotated[StrictFloat, Field(gt=0)]
3714
+ ]
3715
+ ] = None,
3716
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3717
+ _content_type: Optional[StrictStr] = None,
3718
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3719
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3720
+ ) -> ApiResponse[GetPermissionsAPIResponseDTO]:
3721
+ """Retrieve a list of all permissions
3722
+
3723
+ Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header.
3724
+
3725
+ :param tenant_code: Specify the tenant to retrieve the permissions from.
3726
+ :type tenant_code: str
3727
+ :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.
3728
+ :type include_details: bool
3729
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3730
+ :type include_details_with_status: bool
3731
+ :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.
3732
+ :type target_tenant_id: str
3733
+ :param project_id: Optionally, specify a project in which to make the request.
3734
+ :type project_id: str
3735
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3736
+ :type non_versioned: bool
3737
+ :param _request_timeout: timeout setting for this request. If one
3738
+ number provided, it will be total request
3739
+ timeout. It can also be a pair (tuple) of
3740
+ (connection, read) timeouts.
3741
+ :type _request_timeout: int, tuple(int, int), optional
3742
+ :param _request_auth: set to override the auth_settings for an a single
3743
+ request; this effectively ignores the
3744
+ authentication in the spec for a single request.
3745
+ :type _request_auth: dict, optional
3746
+ :param _content_type: force content-type for the request.
3747
+ :type _content_type: str, Optional
3748
+ :param _headers: set to override the headers for a single
3749
+ request; this effectively ignores the headers
3750
+ in the spec for a single request.
3751
+ :type _headers: dict, optional
3752
+ :param _host_index: set to override the host_index for a single
3753
+ request; this effectively ignores the host_index
3754
+ in the spec for a single request.
3755
+ :type _host_index: int, optional
3756
+ :return: Returns the result object.
3757
+ """ # noqa: E501
3758
+
3759
+ _param = self._get_permissions_serialize(
3760
+ tenant_code=tenant_code,
3761
+ include_details=include_details,
3762
+ include_details_with_status=include_details_with_status,
3763
+ target_tenant_id=target_tenant_id,
3764
+ project_id=project_id,
3765
+ non_versioned=non_versioned,
3766
+ _request_auth=_request_auth,
3767
+ _content_type=_content_type,
3768
+ _headers=_headers,
3769
+ _host_index=_host_index
3770
+ )
3771
+
3772
+ _response_types_map: Dict[str, Optional[str]] = {
3773
+ '200': "GetPermissionsAPIResponseDTO",
3774
+ }
3775
+ response_data = self.api_client.call_api(
3776
+ *_param,
3777
+ _request_timeout=_request_timeout
3778
+ )
3779
+ response_data.read()
3780
+ return self.api_client.response_deserialize(
3781
+ response_data=response_data,
3782
+ response_types_map=_response_types_map,
3783
+ )
3784
+
3785
+
3786
+ @validate_call
3787
+ def get_permissions_without_preload_content(
3788
+ self,
3789
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None,
3790
+ include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None,
3791
+ include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None,
3792
+ 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,
3793
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3794
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3795
+ _request_timeout: Union[
3796
+ None,
3797
+ Annotated[StrictFloat, Field(gt=0)],
3798
+ Tuple[
3799
+ Annotated[StrictFloat, Field(gt=0)],
3800
+ Annotated[StrictFloat, Field(gt=0)]
3801
+ ]
3802
+ ] = None,
3803
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3804
+ _content_type: Optional[StrictStr] = None,
3805
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3806
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3807
+ ) -> RESTResponseType:
3808
+ """Retrieve a list of all permissions
3809
+
3810
+ Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header.
3811
+
3812
+ :param tenant_code: Specify the tenant to retrieve the permissions from.
3813
+ :type tenant_code: str
3814
+ :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.
3815
+ :type include_details: bool
3816
+ :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.
3817
+ :type include_details_with_status: bool
3818
+ :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.
3819
+ :type target_tenant_id: str
3820
+ :param project_id: Optionally, specify a project in which to make the request.
3821
+ :type project_id: str
3822
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3823
+ :type non_versioned: bool
3824
+ :param _request_timeout: timeout setting for this request. If one
3825
+ number provided, it will be total request
3826
+ timeout. It can also be a pair (tuple) of
3827
+ (connection, read) timeouts.
3828
+ :type _request_timeout: int, tuple(int, int), optional
3829
+ :param _request_auth: set to override the auth_settings for an a single
3830
+ request; this effectively ignores the
3831
+ authentication in the spec for a single request.
3832
+ :type _request_auth: dict, optional
3833
+ :param _content_type: force content-type for the request.
3834
+ :type _content_type: str, Optional
3835
+ :param _headers: set to override the headers for a single
3836
+ request; this effectively ignores the headers
3837
+ in the spec for a single request.
3838
+ :type _headers: dict, optional
3839
+ :param _host_index: set to override the host_index for a single
3840
+ request; this effectively ignores the host_index
3841
+ in the spec for a single request.
3842
+ :type _host_index: int, optional
3843
+ :return: Returns the result object.
3844
+ """ # noqa: E501
3845
+
3846
+ _param = self._get_permissions_serialize(
3847
+ tenant_code=tenant_code,
3848
+ include_details=include_details,
3849
+ include_details_with_status=include_details_with_status,
3850
+ target_tenant_id=target_tenant_id,
3851
+ project_id=project_id,
3852
+ non_versioned=non_versioned,
3853
+ _request_auth=_request_auth,
3854
+ _content_type=_content_type,
3855
+ _headers=_headers,
3856
+ _host_index=_host_index
3857
+ )
3858
+
3859
+ _response_types_map: Dict[str, Optional[str]] = {
3860
+ '200': "GetPermissionsAPIResponseDTO",
3861
+ }
3862
+ response_data = self.api_client.call_api(
3863
+ *_param,
3864
+ _request_timeout=_request_timeout
3865
+ )
3866
+ return response_data.response
3867
+
3868
+
3869
+ def _get_permissions_serialize(
3870
+ self,
3871
+ tenant_code,
3872
+ include_details,
3873
+ include_details_with_status,
3874
+ target_tenant_id,
3875
+ project_id,
3876
+ non_versioned,
3877
+ _request_auth,
3878
+ _content_type,
3879
+ _headers,
3880
+ _host_index,
3881
+ ) -> RequestSerialized:
3882
+
3883
+ _host = None
3884
+
3885
+ _collection_formats: Dict[str, str] = {
3886
+ }
3887
+
3888
+ _path_params: Dict[str, str] = {}
3889
+ _query_params: List[Tuple[str, str]] = []
3890
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3891
+ _form_params: List[Tuple[str, str]] = []
3892
+ _files: Dict[
3893
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3894
+ ] = {}
3895
+ _body_params: Optional[bytes] = None
3896
+
3897
+ # process the path parameters
3898
+ # process the query parameters
3899
+ if tenant_code is not None:
3900
+
3901
+ _query_params.append(('tenantCode', tenant_code))
3902
+
3903
+ if include_details is not None:
3904
+
3905
+ _query_params.append(('includeDetails', include_details))
3906
+
3907
+ if include_details_with_status is not None:
3908
+
3909
+ _query_params.append(('includeDetailsWithStatus', include_details_with_status))
3910
+
3911
+ # process the header parameters
3912
+ if target_tenant_id is not None:
3913
+ _header_params['TargetTenantID'] = target_tenant_id
3914
+ if project_id is not None:
3915
+ _header_params['ProjectID'] = project_id
3916
+ if non_versioned is not None:
3917
+ _header_params['NonVersioned'] = non_versioned
3918
+ # process the form parameters
3919
+ # process the body parameter
3920
+
3921
+
3922
+ # set the HTTP header `Accept`
3923
+ if 'Accept' not in _header_params:
3924
+ _header_params['Accept'] = self.api_client.select_header_accept(
3925
+ [
3926
+ 'application/json'
3927
+ ]
3928
+ )
3929
+
3930
+
3931
+ # authentication setting
3932
+ _auth_settings: List[str] = [
3933
+ 'CookieAuth',
3934
+ 'ApiKeyAuth',
3935
+ 'OAuth2Auth',
3936
+ 'OAuth2Auth',
3937
+ 'BearerAuth'
3938
+ ]
3939
+
3940
+ return self.api_client.param_serialize(
3941
+ method='GET',
3942
+ resource_path='/v1/admin/permissions',
3943
+ path_params=_path_params,
3944
+ query_params=_query_params,
3945
+ header_params=_header_params,
3946
+ body=_body_params,
3947
+ post_params=_form_params,
3948
+ files=_files,
3949
+ auth_settings=_auth_settings,
3950
+ collection_formats=_collection_formats,
3951
+ _host=_host,
3952
+ _request_auth=_request_auth
3953
+ )
3954
+
3955
+
3956
+
3957
+
3958
+ @validate_call
3959
+ def update_permissions(
3960
+ self,
3961
+ permissions_list_dto: PermissionsListDTO,
3962
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None,
3963
+ 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,
3964
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
3965
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
3966
+ _request_timeout: Union[
3967
+ None,
3968
+ Annotated[StrictFloat, Field(gt=0)],
3969
+ Tuple[
3970
+ Annotated[StrictFloat, Field(gt=0)],
3971
+ Annotated[StrictFloat, Field(gt=0)]
3972
+ ]
3973
+ ] = None,
3974
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3975
+ _content_type: Optional[StrictStr] = None,
3976
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3977
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3978
+ ) -> PermissionBulkOperationResponseDTO:
3979
+ """Update permissions
3980
+
3981
+ Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header.
3982
+
3983
+ :param permissions_list_dto: (required)
3984
+ :type permissions_list_dto: PermissionsListDTO
3985
+ :param tenant_code: Specify the tenant to update permissions in.
3986
+ :type tenant_code: str
3987
+ :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.
3988
+ :type target_tenant_id: str
3989
+ :param project_id: Optionally, specify a project in which to make the request.
3990
+ :type project_id: str
3991
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
3992
+ :type non_versioned: bool
3993
+ :param _request_timeout: timeout setting for this request. If one
3994
+ number provided, it will be total request
3995
+ timeout. It can also be a pair (tuple) of
3996
+ (connection, read) timeouts.
3997
+ :type _request_timeout: int, tuple(int, int), optional
3998
+ :param _request_auth: set to override the auth_settings for an a single
3999
+ request; this effectively ignores the
4000
+ authentication in the spec for a single request.
4001
+ :type _request_auth: dict, optional
4002
+ :param _content_type: force content-type for the request.
4003
+ :type _content_type: str, Optional
4004
+ :param _headers: set to override the headers for a single
4005
+ request; this effectively ignores the headers
4006
+ in the spec for a single request.
4007
+ :type _headers: dict, optional
4008
+ :param _host_index: set to override the host_index for a single
4009
+ request; this effectively ignores the host_index
4010
+ in the spec for a single request.
4011
+ :type _host_index: int, optional
4012
+ :return: Returns the result object.
4013
+ """ # noqa: E501
4014
+
4015
+ _param = self._update_permissions_serialize(
4016
+ permissions_list_dto=permissions_list_dto,
4017
+ tenant_code=tenant_code,
4018
+ target_tenant_id=target_tenant_id,
4019
+ project_id=project_id,
4020
+ non_versioned=non_versioned,
4021
+ _request_auth=_request_auth,
4022
+ _content_type=_content_type,
4023
+ _headers=_headers,
4024
+ _host_index=_host_index
4025
+ )
4026
+
4027
+ _response_types_map: Dict[str, Optional[str]] = {
4028
+ '200': "PermissionBulkOperationResponseDTO",
4029
+ }
4030
+ response_data = self.api_client.call_api(
4031
+ *_param,
4032
+ _request_timeout=_request_timeout
4033
+ )
4034
+ response_data.read()
4035
+ return self.api_client.response_deserialize(
4036
+ response_data=response_data,
4037
+ response_types_map=_response_types_map,
4038
+ ).data
4039
+
4040
+
4041
+ @validate_call
4042
+ def update_permissions_with_http_info(
4043
+ self,
4044
+ permissions_list_dto: PermissionsListDTO,
4045
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None,
4046
+ 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,
4047
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
4048
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
4049
+ _request_timeout: Union[
4050
+ None,
4051
+ Annotated[StrictFloat, Field(gt=0)],
4052
+ Tuple[
4053
+ Annotated[StrictFloat, Field(gt=0)],
4054
+ Annotated[StrictFloat, Field(gt=0)]
4055
+ ]
4056
+ ] = None,
4057
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4058
+ _content_type: Optional[StrictStr] = None,
4059
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4060
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4061
+ ) -> ApiResponse[PermissionBulkOperationResponseDTO]:
4062
+ """Update permissions
4063
+
4064
+ Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header.
4065
+
4066
+ :param permissions_list_dto: (required)
4067
+ :type permissions_list_dto: PermissionsListDTO
4068
+ :param tenant_code: Specify the tenant to update permissions in.
4069
+ :type tenant_code: str
4070
+ :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.
4071
+ :type target_tenant_id: str
4072
+ :param project_id: Optionally, specify a project in which to make the request.
4073
+ :type project_id: str
4074
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
4075
+ :type non_versioned: bool
4076
+ :param _request_timeout: timeout setting for this request. If one
4077
+ number provided, it will be total request
4078
+ timeout. It can also be a pair (tuple) of
4079
+ (connection, read) timeouts.
4080
+ :type _request_timeout: int, tuple(int, int), optional
4081
+ :param _request_auth: set to override the auth_settings for an a single
4082
+ request; this effectively ignores the
4083
+ authentication in the spec for a single request.
4084
+ :type _request_auth: dict, optional
4085
+ :param _content_type: force content-type for the request.
4086
+ :type _content_type: str, Optional
4087
+ :param _headers: set to override the headers for a single
4088
+ request; this effectively ignores the headers
4089
+ in the spec for a single request.
4090
+ :type _headers: dict, optional
4091
+ :param _host_index: set to override the host_index for a single
4092
+ request; this effectively ignores the host_index
4093
+ in the spec for a single request.
4094
+ :type _host_index: int, optional
4095
+ :return: Returns the result object.
4096
+ """ # noqa: E501
4097
+
4098
+ _param = self._update_permissions_serialize(
4099
+ permissions_list_dto=permissions_list_dto,
4100
+ tenant_code=tenant_code,
4101
+ target_tenant_id=target_tenant_id,
4102
+ project_id=project_id,
4103
+ non_versioned=non_versioned,
4104
+ _request_auth=_request_auth,
4105
+ _content_type=_content_type,
4106
+ _headers=_headers,
4107
+ _host_index=_host_index
4108
+ )
4109
+
4110
+ _response_types_map: Dict[str, Optional[str]] = {
4111
+ '200': "PermissionBulkOperationResponseDTO",
4112
+ }
4113
+ response_data = self.api_client.call_api(
4114
+ *_param,
4115
+ _request_timeout=_request_timeout
4116
+ )
4117
+ response_data.read()
4118
+ return self.api_client.response_deserialize(
4119
+ response_data=response_data,
4120
+ response_types_map=_response_types_map,
4121
+ )
4122
+
4123
+
4124
+ @validate_call
4125
+ def update_permissions_without_preload_content(
4126
+ self,
4127
+ permissions_list_dto: PermissionsListDTO,
4128
+ tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None,
4129
+ 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,
4130
+ project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None,
4131
+ non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>")] = None,
4132
+ _request_timeout: Union[
4133
+ None,
4134
+ Annotated[StrictFloat, Field(gt=0)],
4135
+ Tuple[
4136
+ Annotated[StrictFloat, Field(gt=0)],
4137
+ Annotated[StrictFloat, Field(gt=0)]
4138
+ ]
4139
+ ] = None,
4140
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4141
+ _content_type: Optional[StrictStr] = None,
4142
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4143
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4144
+ ) -> RESTResponseType:
4145
+ """Update permissions
4146
+
4147
+ Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header.
4148
+
4149
+ :param permissions_list_dto: (required)
4150
+ :type permissions_list_dto: PermissionsListDTO
4151
+ :param tenant_code: Specify the tenant to update permissions in.
4152
+ :type tenant_code: str
4153
+ :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.
4154
+ :type target_tenant_id: str
4155
+ :param project_id: Optionally, specify a project in which to make the request.
4156
+ :type project_id: str
4157
+ :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.<br>**Note:** <em>This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
4158
+ :type non_versioned: bool
4159
+ :param _request_timeout: timeout setting for this request. If one
4160
+ number provided, it will be total request
4161
+ timeout. It can also be a pair (tuple) of
4162
+ (connection, read) timeouts.
4163
+ :type _request_timeout: int, tuple(int, int), optional
4164
+ :param _request_auth: set to override the auth_settings for an a single
4165
+ request; this effectively ignores the
4166
+ authentication in the spec for a single request.
4167
+ :type _request_auth: dict, optional
4168
+ :param _content_type: force content-type for the request.
4169
+ :type _content_type: str, Optional
4170
+ :param _headers: set to override the headers for a single
4171
+ request; this effectively ignores the headers
4172
+ in the spec for a single request.
4173
+ :type _headers: dict, optional
4174
+ :param _host_index: set to override the host_index for a single
4175
+ request; this effectively ignores the host_index
4176
+ in the spec for a single request.
4177
+ :type _host_index: int, optional
4178
+ :return: Returns the result object.
4179
+ """ # noqa: E501
4180
+
4181
+ _param = self._update_permissions_serialize(
4182
+ permissions_list_dto=permissions_list_dto,
4183
+ tenant_code=tenant_code,
4184
+ target_tenant_id=target_tenant_id,
4185
+ project_id=project_id,
4186
+ non_versioned=non_versioned,
4187
+ _request_auth=_request_auth,
4188
+ _content_type=_content_type,
4189
+ _headers=_headers,
4190
+ _host_index=_host_index
4191
+ )
4192
+
4193
+ _response_types_map: Dict[str, Optional[str]] = {
4194
+ '200': "PermissionBulkOperationResponseDTO",
4195
+ }
4196
+ response_data = self.api_client.call_api(
4197
+ *_param,
4198
+ _request_timeout=_request_timeout
4199
+ )
4200
+ return response_data.response
4201
+
4202
+
4203
+ def _update_permissions_serialize(
4204
+ self,
4205
+ permissions_list_dto,
4206
+ tenant_code,
4207
+ target_tenant_id,
4208
+ project_id,
4209
+ non_versioned,
4210
+ _request_auth,
4211
+ _content_type,
4212
+ _headers,
4213
+ _host_index,
4214
+ ) -> RequestSerialized:
4215
+
4216
+ _host = None
4217
+
4218
+ _collection_formats: Dict[str, str] = {
4219
+ }
4220
+
4221
+ _path_params: Dict[str, str] = {}
4222
+ _query_params: List[Tuple[str, str]] = []
4223
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4224
+ _form_params: List[Tuple[str, str]] = []
4225
+ _files: Dict[
4226
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4227
+ ] = {}
4228
+ _body_params: Optional[bytes] = None
4229
+
4230
+ # process the path parameters
4231
+ # process the query parameters
4232
+ if tenant_code is not None:
4233
+
4234
+ _query_params.append(('tenantCode', tenant_code))
4235
+
4236
+ # process the header parameters
4237
+ if target_tenant_id is not None:
4238
+ _header_params['TargetTenantID'] = target_tenant_id
4239
+ if project_id is not None:
4240
+ _header_params['ProjectID'] = project_id
4241
+ if non_versioned is not None:
4242
+ _header_params['NonVersioned'] = non_versioned
4243
+ # process the form parameters
4244
+ # process the body parameter
4245
+ if permissions_list_dto is not None:
4246
+ _body_params = permissions_list_dto
4247
+
4248
+
4249
+ # set the HTTP header `Accept`
4250
+ if 'Accept' not in _header_params:
4251
+ _header_params['Accept'] = self.api_client.select_header_accept(
4252
+ [
4253
+ 'application/json'
4254
+ ]
4255
+ )
4256
+
4257
+ # set the HTTP header `Content-Type`
4258
+ if _content_type:
4259
+ _header_params['Content-Type'] = _content_type
4260
+ else:
4261
+ _default_content_type = (
4262
+ self.api_client.select_header_content_type(
4263
+ [
4264
+ 'application/json'
4265
+ ]
4266
+ )
4267
+ )
4268
+ if _default_content_type is not None:
4269
+ _header_params['Content-Type'] = _default_content_type
4270
+
4271
+ # authentication setting
4272
+ _auth_settings: List[str] = [
4273
+ 'CookieAuth',
4274
+ 'ApiKeyAuth',
4275
+ 'OAuth2Auth',
4276
+ 'OAuth2Auth',
4277
+ 'BearerAuth'
4278
+ ]
4279
+
4280
+ return self.api_client.param_serialize(
4281
+ method='PUT',
4282
+ resource_path='/v1/admin/permissions',
4283
+ path_params=_path_params,
4284
+ query_params=_query_params,
4285
+ header_params=_header_params,
4286
+ body=_body_params,
4287
+ post_params=_form_params,
4288
+ files=_files,
4289
+ auth_settings=_auth_settings,
4290
+ collection_formats=_collection_formats,
4291
+ _host=_host,
4292
+ _request_auth=_request_auth
4293
+ )
4294
+
4295
+