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