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