visier-platform-sdk 22222222.99200.21494__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of visier-platform-sdk might be problematic. Click here for more details.
- visier_platform_sdk/__init__.py +1404 -0
- visier_platform_sdk/api/__init__.py +43 -0
- visier_platform_sdk/api/basic_authentication_api.py +625 -0
- visier_platform_sdk/api/benchmarks_api.py +936 -0
- visier_platform_sdk/api/concepts_v2_api.py +2307 -0
- visier_platform_sdk/api/consolidated_analytics_api.py +3265 -0
- visier_platform_sdk/api/data_and_job_handling_api.py +8380 -0
- visier_platform_sdk/api/data_intake_api.py +1866 -0
- visier_platform_sdk/api/data_model_api.py +13164 -0
- visier_platform_sdk/api/data_query_api.py +1226 -0
- visier_platform_sdk/api/data_upload_api.py +343 -0
- visier_platform_sdk/api/data_version_export_api.py +1724 -0
- visier_platform_sdk/api/dimensions_api.py +3050 -0
- visier_platform_sdk/api/dimensions_v2_api.py +2344 -0
- visier_platform_sdk/api/direct_data_intake_api.py +3039 -0
- visier_platform_sdk/api/email_domains_api.py +843 -0
- visier_platform_sdk/api/encryption_keys_api.py +835 -0
- visier_platform_sdk/api/jobs_library_api.py +1168 -0
- visier_platform_sdk/api/network_subnets_api.py +1170 -0
- visier_platform_sdk/api/o_auth2_api.py +1036 -0
- visier_platform_sdk/api/object_configuration_api.py +1752 -0
- visier_platform_sdk/api/permissions_api.py +4295 -0
- visier_platform_sdk/api/pgp_keys_api.py +1161 -0
- visier_platform_sdk/api/planning_data_load_api.py +740 -0
- visier_platform_sdk/api/production_versions_api.py +944 -0
- visier_platform_sdk/api/profiles_api.py +2873 -0
- visier_platform_sdk/api/projects_api.py +2128 -0
- visier_platform_sdk/api/release_version_configuration_api.py +835 -0
- visier_platform_sdk/api/reporting_api.py +1757 -0
- visier_platform_sdk/api/search_api.py +356 -0
- visier_platform_sdk/api/skills_library_api.py +2632 -0
- visier_platform_sdk/api/source_files_download_api.py +335 -0
- visier_platform_sdk/api/sources_api.py +652 -0
- visier_platform_sdk/api/system_status_api.py +570 -0
- visier_platform_sdk/api/tenants_v1_api.py +2836 -0
- visier_platform_sdk/api/tenants_v2_api.py +1595 -0
- visier_platform_sdk/api/user_groups_v2_api.py +2332 -0
- visier_platform_sdk/api/users_v1_api.py +6157 -0
- visier_platform_sdk/api/users_v2_api.py +973 -0
- visier_platform_sdk/api/vee_api.py +1161 -0
- visier_platform_sdk/api/webhooks_api.py +2281 -0
- visier_platform_sdk/api_client.py +811 -0
- visier_platform_sdk/api_response.py +21 -0
- visier_platform_sdk/configuration.py +808 -0
- visier_platform_sdk/exceptions.py +217 -0
- visier_platform_sdk/models/__init__.py +657 -0
- visier_platform_sdk/models/accessible_tenant_profile_assignment_request_dto.py +102 -0
- visier_platform_sdk/models/accessible_tenant_profile_assignment_response_dto.py +128 -0
- visier_platform_sdk/models/accessible_tenant_profile_revoke_request_dto.py +98 -0
- visier_platform_sdk/models/accessible_tenant_profile_revoke_response_dto.py +125 -0
- visier_platform_sdk/models/additional_capabilities_dto.py +88 -0
- visier_platform_sdk/models/admin_capability_config_dto.py +90 -0
- visier_platform_sdk/models/adp_auth_params_dto.py +88 -0
- visier_platform_sdk/models/aggregation_query_dto.py +128 -0
- visier_platform_sdk/models/aggregation_query_execution_dto.py +98 -0
- visier_platform_sdk/models/aggregation_query_source_dto.py +96 -0
- visier_platform_sdk/models/aggregation_query_source_metric_dto.py +94 -0
- visier_platform_sdk/models/aggregation_query_source_metrics_dto.py +96 -0
- visier_platform_sdk/models/aggregation_type_option_dto.py +96 -0
- visier_platform_sdk/models/aggregation_type_parameter_dto.py +102 -0
- visier_platform_sdk/models/aggregation_type_parameter_value_dto.py +90 -0
- visier_platform_sdk/models/all_permissions_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_profile_assigned_for_accessible_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_profile_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_tenants_status_apidto.py +100 -0
- visier_platform_sdk/models/all_user_groups_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_users_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/analytic_object_definition_dto.py +102 -0
- visier_platform_sdk/models/analytic_object_dto.py +132 -0
- visier_platform_sdk/models/analytic_object_filter_dto.py +94 -0
- visier_platform_sdk/models/analytic_object_filter_list_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_names_dto.py +88 -0
- visier_platform_sdk/models/analytic_object_reference_dto.py +88 -0
- visier_platform_sdk/models/analytic_object_reference_list_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_request_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_with_context_dto.py +98 -0
- visier_platform_sdk/models/analytic_objects_dto.py +96 -0
- visier_platform_sdk/models/any.py +101 -0
- visier_platform_sdk/models/api_error.py +92 -0
- visier_platform_sdk/models/assign_connector_credential_request.py +96 -0
- visier_platform_sdk/models/assign_connector_credentials_by_tenant_response_dto.py +112 -0
- visier_platform_sdk/models/assign_connector_credentials_response_dto.py +96 -0
- visier_platform_sdk/models/assign_connector_with_credentials_response_dto.py +98 -0
- visier_platform_sdk/models/assign_revoke_permission_by_permission_dto.py +102 -0
- visier_platform_sdk/models/assign_revoke_permission_by_tenant_dto.py +114 -0
- visier_platform_sdk/models/assign_revoke_permission_by_user_dto.py +92 -0
- visier_platform_sdk/models/assign_revoke_permission_request_dto.py +90 -0
- visier_platform_sdk/models/assign_revoke_permissions_request_dto.py +102 -0
- visier_platform_sdk/models/assign_revoke_permissions_response_dto.py +96 -0
- visier_platform_sdk/models/assigned_credential_info_response_dto.py +92 -0
- visier_platform_sdk/models/bamboo_auth_params_dto.py +90 -0
- visier_platform_sdk/models/basic_information_dto.py +102 -0
- visier_platform_sdk/models/basic_s3_auth_params_dto.py +96 -0
- visier_platform_sdk/models/batch_tenant_provision_apidto.py +96 -0
- visier_platform_sdk/models/benchmark_info.py +92 -0
- visier_platform_sdk/models/benchmark_value.py +108 -0
- visier_platform_sdk/models/big_query_auth_params_dto.py +104 -0
- visier_platform_sdk/models/big_query_service_account_params_dto.py +90 -0
- visier_platform_sdk/models/bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/bulk_data_access_set_response_dto.py +106 -0
- visier_platform_sdk/models/business_location_dto.py +90 -0
- visier_platform_sdk/models/calculated_property_type_dto.py +90 -0
- visier_platform_sdk/models/calculated_selection_concept_dto.py +104 -0
- visier_platform_sdk/models/calculation_concept_configuration_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_configuration_map_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_list_dto.py +96 -0
- visier_platform_sdk/models/cancel_job_batch_from_job_id_dto.py +88 -0
- visier_platform_sdk/models/capabilities_dto.py +92 -0
- visier_platform_sdk/models/capability_dto.py +92 -0
- visier_platform_sdk/models/capability_group_dto.py +146 -0
- visier_platform_sdk/models/cell_distribution_bin_dto.py +90 -0
- visier_platform_sdk/models/cell_distribution_options_dto.py +88 -0
- visier_platform_sdk/models/cell_dto.py +102 -0
- visier_platform_sdk/models/cell_set_axis_dto.py +102 -0
- visier_platform_sdk/models/cell_set_axis_position_dto.py +92 -0
- visier_platform_sdk/models/cell_set_dto.py +114 -0
- visier_platform_sdk/models/cell_set_or_error_dto.py +98 -0
- visier_platform_sdk/models/clone_files_into_source_parameters_dto.py +96 -0
- visier_platform_sdk/models/cohort_filter_dto.py +100 -0
- visier_platform_sdk/models/commit_and_publish_operation_response_dto.py +92 -0
- visier_platform_sdk/models/commit_dto.py +92 -0
- visier_platform_sdk/models/concept_configuration_result_dto.py +92 -0
- visier_platform_sdk/models/concept_definition_dto.py +108 -0
- visier_platform_sdk/models/concept_delete_request_dto.py +96 -0
- visier_platform_sdk/models/concept_delete_with_context_dto.py +98 -0
- visier_platform_sdk/models/concept_request_dto.py +96 -0
- visier_platform_sdk/models/concept_response_dto.py +96 -0
- visier_platform_sdk/models/concept_type_details_dto.py +104 -0
- visier_platform_sdk/models/concept_with_context_dto.py +98 -0
- visier_platform_sdk/models/connector.py +98 -0
- visier_platform_sdk/models/connector_info_response_dto.py +92 -0
- visier_platform_sdk/models/connector_setting_request_dto.py +90 -0
- visier_platform_sdk/models/connector_setting_response_dto.py +92 -0
- visier_platform_sdk/models/connector_settings_response_dto.py +102 -0
- visier_platform_sdk/models/consolidated_analytics_api_excluded_source_list_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_source_tenant_list_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_create_request_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_list_response_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details.py +92 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details_list_response_dto.py +96 -0
- visier_platform_sdk/models/consolidated_analytics_job_request_dto.py +88 -0
- visier_platform_sdk/models/content_package_dto.py +92 -0
- visier_platform_sdk/models/copy_s3_auth_params_dto.py +88 -0
- visier_platform_sdk/models/create_data_access_set_request_dto.py +96 -0
- visier_platform_sdk/models/credential_creation_api_response_dto.py +102 -0
- visier_platform_sdk/models/currencies_dto.py +96 -0
- visier_platform_sdk/models/currency_dto.py +94 -0
- visier_platform_sdk/models/currency_rate_dto.py +96 -0
- visier_platform_sdk/models/currency_rates_dto.py +96 -0
- visier_platform_sdk/models/custom_property_dto.py +90 -0
- visier_platform_sdk/models/custom_tenant_property_dto.py +90 -0
- visier_platform_sdk/models/data_access_set_dto.py +104 -0
- visier_platform_sdk/models/data_access_set_error_dto.py +90 -0
- visier_platform_sdk/models/data_access_set_failure_dto.py +96 -0
- visier_platform_sdk/models/data_access_set_success_dto.py +90 -0
- visier_platform_sdk/models/data_categories_response_dto.py +96 -0
- visier_platform_sdk/models/data_category_response_dto.py +92 -0
- visier_platform_sdk/models/data_load_request.py +92 -0
- visier_platform_sdk/models/data_load_request_model.py +90 -0
- visier_platform_sdk/models/data_load_response.py +88 -0
- visier_platform_sdk/models/data_model_analytic_object_dto.py +130 -0
- visier_platform_sdk/models/data_provider_auth_information_dto.py +104 -0
- visier_platform_sdk/models/data_provider_auth_params_dto.py +344 -0
- visier_platform_sdk/models/data_provider_basic_information_dto.py +90 -0
- visier_platform_sdk/models/data_provider_basic_metadata_dto.py +88 -0
- visier_platform_sdk/models/data_security_profile_dto.py +134 -0
- visier_platform_sdk/models/data_transfer_result_detail.py +94 -0
- visier_platform_sdk/models/data_version_and_date_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_column_dto.py +94 -0
- visier_platform_sdk/models/data_version_export_data_version_summary_dto.py +92 -0
- visier_platform_sdk/models/data_version_export_data_versions_dto.py +96 -0
- visier_platform_sdk/models/data_version_export_dto.py +108 -0
- visier_platform_sdk/models/data_version_export_file_dto.py +106 -0
- visier_platform_sdk/models/data_version_export_job_status_dto.py +94 -0
- visier_platform_sdk/models/data_version_export_part_file_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_schedule_job_request_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_schedule_job_response_dto.py +88 -0
- visier_platform_sdk/models/data_version_export_table_dto.py +101 -0
- visier_platform_sdk/models/data_version_exports_dto.py +96 -0
- visier_platform_sdk/models/data_version_object.py +92 -0
- visier_platform_sdk/models/databricks_auth_params_dto.py +94 -0
- visier_platform_sdk/models/date_range_dto.py +90 -0
- visier_platform_sdk/models/dayforce_v2_auth_params_dto.py +96 -0
- visier_platform_sdk/models/delete_permissions_request_dto.py +88 -0
- visier_platform_sdk/models/delete_user_group_v2_request.py +88 -0
- visier_platform_sdk/models/dependent_dto.py +92 -0
- visier_platform_sdk/models/description_entry.py +90 -0
- visier_platform_sdk/models/designer_dimension_filter_dto.py +100 -0
- visier_platform_sdk/models/designer_selection_concept_dto.py +96 -0
- visier_platform_sdk/models/dimension_change_definition_dto.py +94 -0
- visier_platform_sdk/models/dimension_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/dimension_delete_request_dto.py +96 -0
- visier_platform_sdk/models/dimension_delete_with_context_dto.py +98 -0
- visier_platform_sdk/models/dimension_details_dto.py +98 -0
- visier_platform_sdk/models/dimension_dto.py +120 -0
- visier_platform_sdk/models/dimension_filter_dto.py +100 -0
- visier_platform_sdk/models/dimension_filter_list_dto.py +96 -0
- visier_platform_sdk/models/dimension_mapping_validation_dto.py +102 -0
- visier_platform_sdk/models/dimension_mapping_validation_execution_dto.py +90 -0
- visier_platform_sdk/models/dimension_member.py +139 -0
- visier_platform_sdk/models/dimension_member_dto.py +88 -0
- visier_platform_sdk/models/dimension_member_reference_dto.py +90 -0
- visier_platform_sdk/models/dimension_reference_dto.py +90 -0
- visier_platform_sdk/models/dimension_request_dto.py +96 -0
- visier_platform_sdk/models/dimension_response_dto.py +96 -0
- visier_platform_sdk/models/dimension_with_context_dto.py +98 -0
- visier_platform_sdk/models/dimensions_auth_params_dto.py +98 -0
- visier_platform_sdk/models/dimensions_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/dimensions_dto.py +96 -0
- visier_platform_sdk/models/direct_data_job_config_dto.py +100 -0
- visier_platform_sdk/models/direct_data_job_status_response_dto.py +96 -0
- visier_platform_sdk/models/direct_data_list_transactions_response_dto.py +96 -0
- visier_platform_sdk/models/direct_data_load_config_dto.py +92 -0
- visier_platform_sdk/models/direct_data_schema_dto.py +96 -0
- visier_platform_sdk/models/direct_data_schema_field_dto.py +96 -0
- visier_platform_sdk/models/direct_data_transaction_dto.py +96 -0
- visier_platform_sdk/models/direct_data_transaction_start_response_dto.py +88 -0
- visier_platform_sdk/models/direct_data_upload_file_response_dto.py +92 -0
- visier_platform_sdk/models/disable_dv_model.py +96 -0
- visier_platform_sdk/models/disable_dv_request.py +92 -0
- visier_platform_sdk/models/disable_dv_response.py +100 -0
- visier_platform_sdk/models/dispatching_job_status_response.py +94 -0
- visier_platform_sdk/models/document_search_link_dto.py +90 -0
- visier_platform_sdk/models/download_source_files_dto.py +102 -0
- visier_platform_sdk/models/download_source_files_response_dto.py +90 -0
- visier_platform_sdk/models/dv_export_status.py +96 -0
- visier_platform_sdk/models/dynamic_dimension_filter_dto.py +112 -0
- visier_platform_sdk/models/dynamic_property_mapping_dto.py +106 -0
- visier_platform_sdk/models/element_ids_dto.py +88 -0
- visier_platform_sdk/models/email_domains_dto.py +90 -0
- visier_platform_sdk/models/error_dto.py +92 -0
- visier_platform_sdk/models/exclude_data_uploads_request.py +96 -0
- visier_platform_sdk/models/excluded_sources_body.py +88 -0
- visier_platform_sdk/models/execution_context_dto.py +90 -0
- visier_platform_sdk/models/export_production_versions_api_operation_parameters_dto.py +92 -0
- visier_platform_sdk/models/extract_data_and_load_dto.py +150 -0
- visier_platform_sdk/models/extracted_skill.py +94 -0
- visier_platform_sdk/models/extraction_job.py +94 -0
- visier_platform_sdk/models/extraction_job_and_status_response.py +104 -0
- visier_platform_sdk/models/extractor_credential_apidto.py +96 -0
- visier_platform_sdk/models/extractor_credentials_apidto.py +100 -0
- visier_platform_sdk/models/extractor_setting_apidto.py +100 -0
- visier_platform_sdk/models/extractor_setting_key_value_apidto.py +90 -0
- visier_platform_sdk/models/extractor_settings_apidto.py +96 -0
- visier_platform_sdk/models/failed_accessible_tenant_profile_assignment_dto.py +98 -0
- visier_platform_sdk/models/failed_change_dto.py +100 -0
- visier_platform_sdk/models/failed_local_tenant_profile_assignment_dto.py +94 -0
- visier_platform_sdk/models/failed_local_tenant_profile_revoke_dto.py +90 -0
- visier_platform_sdk/models/fusion_auth_params_dto.py +92 -0
- visier_platform_sdk/models/generate_impersonation_token_request.py +88 -0
- visier_platform_sdk/models/generate_key_request_dto.py +92 -0
- visier_platform_sdk/models/get_capabilities_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_content_packages_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_data_access_sets_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_data_security_objects_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_permissions_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_plan_list_response_dto.py +98 -0
- visier_platform_sdk/models/get_production_versions_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_projects_api_response_dto.py +123 -0
- visier_platform_sdk/models/gong_auth_params_dto.py +90 -0
- visier_platform_sdk/models/google_sheets_auth_params_dto.py +94 -0
- visier_platform_sdk/models/google_workspace_auth_params_dto.py +96 -0
- visier_platform_sdk/models/greenhouse_auth_params_dto.py +88 -0
- visier_platform_sdk/models/hierarchy.py +92 -0
- visier_platform_sdk/models/hierarchy_property_dto.py +90 -0
- visier_platform_sdk/models/home_analysis_by_user_group_dto.py +90 -0
- visier_platform_sdk/models/icims_auth_params_dto.py +108 -0
- visier_platform_sdk/models/import_definition_apidto.py +92 -0
- visier_platform_sdk/models/import_definitions_apidto.py +100 -0
- visier_platform_sdk/models/include_data_uploads_request.py +96 -0
- visier_platform_sdk/models/inherited_access_config_dto.py +100 -0
- visier_platform_sdk/models/inherited_reference_member_filter_config_dto.py +90 -0
- visier_platform_sdk/models/internal_query_execution_options_dto.py +100 -0
- visier_platform_sdk/models/internal_s3_auth_params_dto.py +90 -0
- visier_platform_sdk/models/jdbc_auth_params_dto.py +92 -0
- visier_platform_sdk/models/jira_auth_params_dto.py +96 -0
- visier_platform_sdk/models/jira_connect_params_dto.py +92 -0
- visier_platform_sdk/models/job.py +121 -0
- visier_platform_sdk/models/job_cancellation_result_dto.py +110 -0
- visier_platform_sdk/models/job_cancellation_results_dto.py +96 -0
- visier_platform_sdk/models/job_entry.py +92 -0
- visier_platform_sdk/models/job_feedback_input.py +92 -0
- visier_platform_sdk/models/job_id_response.py +88 -0
- visier_platform_sdk/models/job_search_failure_output.py +94 -0
- visier_platform_sdk/models/job_search_input.py +88 -0
- visier_platform_sdk/models/job_search_output.py +106 -0
- visier_platform_sdk/models/job_standardization_input.py +98 -0
- visier_platform_sdk/models/job_standardization_input_skills.py +90 -0
- visier_platform_sdk/models/job_status_list_response.py +100 -0
- visier_platform_sdk/models/job_status_with_start_time.py +96 -0
- visier_platform_sdk/models/key_group_filter_dto.py +96 -0
- visier_platform_sdk/models/key_group_filter_item_dto.py +100 -0
- visier_platform_sdk/models/key_name.py +88 -0
- visier_platform_sdk/models/key_pair_delete_response_dto.py +88 -0
- visier_platform_sdk/models/key_pair_generate_request_dto.py +88 -0
- visier_platform_sdk/models/last_login_dto.py +88 -0
- visier_platform_sdk/models/level_dto.py +92 -0
- visier_platform_sdk/models/level_list_dto.py +96 -0
- visier_platform_sdk/models/leveled_details_dto.py +102 -0
- visier_platform_sdk/models/lever_auth_params_dto.py +88 -0
- visier_platform_sdk/models/lineage_dto.py +100 -0
- visier_platform_sdk/models/list_query_execution_dto.py +144 -0
- visier_platform_sdk/models/list_query_execution_options_dto.py +158 -0
- visier_platform_sdk/models/list_query_source_dto.py +94 -0
- visier_platform_sdk/models/list_response.py +101 -0
- visier_platform_sdk/models/local_tenant_profile_assignment_request_dto.py +92 -0
- visier_platform_sdk/models/local_tenant_profile_assignment_response_dto.py +118 -0
- visier_platform_sdk/models/local_tenant_profile_revoke_request_dto.py +88 -0
- visier_platform_sdk/models/local_tenant_profile_revoke_response_dto.py +106 -0
- visier_platform_sdk/models/location_search_failure_output.py +96 -0
- visier_platform_sdk/models/location_search_input.py +98 -0
- visier_platform_sdk/models/location_search_input1.py +92 -0
- visier_platform_sdk/models/location_search_output.py +106 -0
- visier_platform_sdk/models/location_search_successful_output.py +98 -0
- visier_platform_sdk/models/mask_message.py +88 -0
- visier_platform_sdk/models/medallia_auth_params_dto.py +94 -0
- visier_platform_sdk/models/member_dto.py +106 -0
- visier_platform_sdk/models/member_filter_config_dto.py +96 -0
- visier_platform_sdk/models/member_filter_dto.py +98 -0
- visier_platform_sdk/models/member_parameter_definition_dto.py +102 -0
- visier_platform_sdk/models/member_parameter_value_dto.py +98 -0
- visier_platform_sdk/models/member_selection_concept_dto.py +102 -0
- visier_platform_sdk/models/member_selection_dto.py +90 -0
- visier_platform_sdk/models/member_selection_list_dto.py +96 -0
- visier_platform_sdk/models/member_values_dto.py +105 -0
- visier_platform_sdk/models/members_dto.py +96 -0
- visier_platform_sdk/models/metric_definition_dto.py +114 -0
- visier_platform_sdk/models/metric_dto.py +122 -0
- visier_platform_sdk/models/metric_type_details_dto.py +92 -0
- visier_platform_sdk/models/metric_validation_summary_dto.py +92 -0
- visier_platform_sdk/models/metrics_dto.py +96 -0
- visier_platform_sdk/models/microsoft365_auth_params_dto.py +94 -0
- visier_platform_sdk/models/module_settings_dto.py +92 -0
- visier_platform_sdk/models/multiple_tenant_data_versions_details_dto.py +98 -0
- visier_platform_sdk/models/multiple_tenant_data_versions_list_dto.py +100 -0
- visier_platform_sdk/models/my_sql_auth_params_dto.py +98 -0
- visier_platform_sdk/models/namely_auth_params_dto.py +88 -0
- visier_platform_sdk/models/network_subnets_message_request.py +90 -0
- visier_platform_sdk/models/network_subnets_message_response.py +88 -0
- visier_platform_sdk/models/numeric_parameter_definition_dto.py +98 -0
- visier_platform_sdk/models/numeric_parameter_value_dto.py +90 -0
- visier_platform_sdk/models/o_auth2_user_info_dto.py +117 -0
- visier_platform_sdk/models/o_auth2_user_subnet_info_dto.py +100 -0
- visier_platform_sdk/models/o_auth2_user_tenant_detail_dto.py +96 -0
- visier_platform_sdk/models/o_auth2_user_tenant_details_dto.py +96 -0
- visier_platform_sdk/models/o_auth2_user_tenant_properties_dto.py +88 -0
- visier_platform_sdk/models/object_change_failure_dto.py +98 -0
- visier_platform_sdk/models/object_change_success_dto.py +94 -0
- visier_platform_sdk/models/object_id_dto.py +90 -0
- visier_platform_sdk/models/object_reference_dto.py +110 -0
- visier_platform_sdk/models/objects_bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/oracle_db_auth_params_dto.py +96 -0
- visier_platform_sdk/models/output_entry.py +98 -0
- visier_platform_sdk/models/output_entry1.py +98 -0
- visier_platform_sdk/models/output_entry1_matches_inner.py +94 -0
- visier_platform_sdk/models/pair_dto.py +90 -0
- visier_platform_sdk/models/parameter_definition_dto.py +110 -0
- visier_platform_sdk/models/parent_child_details_dto.py +108 -0
- visier_platform_sdk/models/permission_assigned_by_tenant_dto.py +98 -0
- visier_platform_sdk/models/permission_assigned_for_local_tenant_dto.py +92 -0
- visier_platform_sdk/models/permission_assigned_user_dto.py +92 -0
- visier_platform_sdk/models/permission_assigned_users_dto.py +100 -0
- visier_platform_sdk/models/permission_bulk_operation_response_dto.py +106 -0
- visier_platform_sdk/models/permission_dto.py +114 -0
- visier_platform_sdk/models/permission_error_dto.py +90 -0
- visier_platform_sdk/models/permission_failure_dto.py +96 -0
- visier_platform_sdk/models/permission_response_dto.py +90 -0
- visier_platform_sdk/models/permission_success_dto.py +90 -0
- visier_platform_sdk/models/permissions_list_dto.py +96 -0
- visier_platform_sdk/models/permissions_to_user_group_for_tenant_dto.py +102 -0
- visier_platform_sdk/models/permissions_to_user_group_request_dto.py +90 -0
- visier_platform_sdk/models/permissions_to_user_groups_request_dto.py +96 -0
- visier_platform_sdk/models/perspective_configuration_dto.py +100 -0
- visier_platform_sdk/models/perspective_node_dto.py +100 -0
- visier_platform_sdk/models/plan_data_load_change_dto.py +94 -0
- visier_platform_sdk/models/plan_data_load_change_list_dto.py +98 -0
- visier_platform_sdk/models/plan_data_load_error_dto.py +92 -0
- visier_platform_sdk/models/plan_data_upload_response_dto.py +110 -0
- visier_platform_sdk/models/plan_info_dto.py +106 -0
- visier_platform_sdk/models/plan_item_dto.py +102 -0
- visier_platform_sdk/models/plan_parameter_definition_dto.py +94 -0
- visier_platform_sdk/models/plan_parameter_value_dto.py +94 -0
- visier_platform_sdk/models/plan_row_data_load_response_dto.py +114 -0
- visier_platform_sdk/models/plan_schema_dto.py +126 -0
- visier_platform_sdk/models/plan_segment_level_dto.py +96 -0
- visier_platform_sdk/models/plan_segment_level_member_dto.py +94 -0
- visier_platform_sdk/models/plan_segment_level_member_list_dto.py +100 -0
- visier_platform_sdk/models/plan_time_period_dto.py +90 -0
- visier_platform_sdk/models/plan_with_schema_dto.py +108 -0
- visier_platform_sdk/models/planning_concept_filter_context_dto.py +88 -0
- visier_platform_sdk/models/planning_hierarchy_filter_context_dto.py +92 -0
- visier_platform_sdk/models/planning_model_dto.py +92 -0
- visier_platform_sdk/models/planning_models_dto.py +96 -0
- visier_platform_sdk/models/planning_plan_context_dto.py +98 -0
- visier_platform_sdk/models/planning_plan_dto.py +123 -0
- visier_platform_sdk/models/planning_plans_dto.py +96 -0
- visier_platform_sdk/models/population_configuration_dto.py +115 -0
- visier_platform_sdk/models/prediction_dto.py +124 -0
- visier_platform_sdk/models/predictions_dto.py +96 -0
- visier_platform_sdk/models/process_concept_definition_dto.py +128 -0
- visier_platform_sdk/models/process_concept_member_dto.py +90 -0
- visier_platform_sdk/models/process_concept_member_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_metric_definition_dto.py +92 -0
- visier_platform_sdk/models/process_concept_metric_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_outcome_dto.py +114 -0
- visier_platform_sdk/models/process_concept_outcome_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_property_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_property_type_dto.py +92 -0
- visier_platform_sdk/models/process_concept_stage_dto.py +102 -0
- visier_platform_sdk/models/process_concept_stage_list_dto.py +96 -0
- visier_platform_sdk/models/processing_job.py +96 -0
- visier_platform_sdk/models/processing_job_and_status_response.py +104 -0
- visier_platform_sdk/models/processing_job_request_dto.py +96 -0
- visier_platform_sdk/models/processing_job_status_response.py +104 -0
- visier_platform_sdk/models/product_release_dto.py +94 -0
- visier_platform_sdk/models/product_releases_dto.py +96 -0
- visier_platform_sdk/models/product_version_dto.py +92 -0
- visier_platform_sdk/models/product_versions_dto.py +96 -0
- visier_platform_sdk/models/product_versions_update_failure_tenant_response_dto.py +94 -0
- visier_platform_sdk/models/product_versions_update_response_dto.py +106 -0
- visier_platform_sdk/models/product_versions_update_successful_tenant_response_dto.py +92 -0
- visier_platform_sdk/models/production_version_api_operation_request_dto.py +98 -0
- visier_platform_sdk/models/production_version_api_operation_response_dto.py +92 -0
- visier_platform_sdk/models/production_versions_api_operation_request_dto.py +104 -0
- visier_platform_sdk/models/production_versions_api_operation_response_dto.py +88 -0
- visier_platform_sdk/models/profile_assigned_for_accessible_tenant_dto.py +98 -0
- visier_platform_sdk/models/profile_assigned_for_local_tenant_dto.py +110 -0
- visier_platform_sdk/models/profile_get_api_response_dto.py +102 -0
- visier_platform_sdk/models/profiles_get_api_response_dto.py +96 -0
- visier_platform_sdk/models/project_commits_api_response_dto.py +96 -0
- visier_platform_sdk/models/project_dto.py +111 -0
- visier_platform_sdk/models/project_operation_request_dto.py +98 -0
- visier_platform_sdk/models/project_operation_response_dto.py +92 -0
- visier_platform_sdk/models/properties_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/properties_delete_definitions_dto.py +100 -0
- visier_platform_sdk/models/properties_dto.py +96 -0
- visier_platform_sdk/models/property_access_config_dto.py +116 -0
- visier_platform_sdk/models/property_bulk_delete_response_dto.py +106 -0
- visier_platform_sdk/models/property_change_definition_dto.py +112 -0
- visier_platform_sdk/models/property_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/property_column_dto.py +94 -0
- visier_platform_sdk/models/property_definition_dto.py +102 -0
- visier_platform_sdk/models/property_delete_definitions_by_tenant_dto.py +92 -0
- visier_platform_sdk/models/property_delete_failure_dto.py +117 -0
- visier_platform_sdk/models/property_delete_success_dto.py +113 -0
- visier_platform_sdk/models/property_dependency_dto.py +90 -0
- visier_platform_sdk/models/property_dependency_list_dto.py +96 -0
- visier_platform_sdk/models/property_dto.py +118 -0
- visier_platform_sdk/models/property_reference_dto.py +90 -0
- visier_platform_sdk/models/property_set_config_dto.py +102 -0
- visier_platform_sdk/models/property_type_details_dto.py +104 -0
- visier_platform_sdk/models/property_type_dto.py +98 -0
- visier_platform_sdk/models/public_key_dto.py +96 -0
- visier_platform_sdk/models/public_keys_dto.py +96 -0
- visier_platform_sdk/models/push_data_cancel_response.py +102 -0
- visier_platform_sdk/models/push_data_column_definition_dto.py +98 -0
- visier_platform_sdk/models/push_data_complete_request.py +90 -0
- visier_platform_sdk/models/push_data_complete_response.py +104 -0
- visier_platform_sdk/models/push_data_response.py +104 -0
- visier_platform_sdk/models/push_data_source_definition_dto.py +106 -0
- visier_platform_sdk/models/push_data_source_definitions_dto.py +96 -0
- visier_platform_sdk/models/put_project_commits_request.py +88 -0
- visier_platform_sdk/models/qualifying_path_dto.py +88 -0
- visier_platform_sdk/models/qualtrics_auth_params_dto.py +90 -0
- visier_platform_sdk/models/query_axis_dto.py +141 -0
- visier_platform_sdk/models/query_axis_options_dto.py +100 -0
- visier_platform_sdk/models/query_dimension_data_member_selection_dto.py +92 -0
- visier_platform_sdk/models/query_dimension_leaf_selection_dto.py +92 -0
- visier_platform_sdk/models/query_dimension_level_property_dto.py +108 -0
- visier_platform_sdk/models/query_dimension_level_selection_dto.py +96 -0
- visier_platform_sdk/models/query_dimension_member_selection_dto.py +102 -0
- visier_platform_sdk/models/query_execution_error_details_dto.py +94 -0
- visier_platform_sdk/models/query_execution_error_dto.py +100 -0
- visier_platform_sdk/models/query_execution_errors_dto.py +100 -0
- visier_platform_sdk/models/query_execution_options_dto.py +192 -0
- visier_platform_sdk/models/query_filter_dto.py +106 -0
- visier_platform_sdk/models/query_member_map_property_dto.py +94 -0
- visier_platform_sdk/models/query_member_map_selection_dto.py +104 -0
- visier_platform_sdk/models/query_numeric_ranges_dto.py +100 -0
- visier_platform_sdk/models/query_parameter_value_dto.py +110 -0
- visier_platform_sdk/models/query_property_dto.py +120 -0
- visier_platform_sdk/models/query_time_interval_dto.py +134 -0
- visier_platform_sdk/models/query_time_intervals_dto.py +150 -0
- visier_platform_sdk/models/question_categories_api_response_dto.py +96 -0
- visier_platform_sdk/models/question_category_api_response_dto.py +90 -0
- visier_platform_sdk/models/receiving_job.py +92 -0
- visier_platform_sdk/models/receiving_job_and_status_response.py +104 -0
- visier_platform_sdk/models/receiving_job_status_response.py +104 -0
- visier_platform_sdk/models/redshift_auth_params_dto.py +100 -0
- visier_platform_sdk/models/reduced_error_dto.py +88 -0
- visier_platform_sdk/models/reduced_tenant_code_error_dto.py +96 -0
- visier_platform_sdk/models/reduced_user_id_error_dto.py +94 -0
- visier_platform_sdk/models/related_analytic_object_dto.py +90 -0
- visier_platform_sdk/models/report_create_request_dto.py +90 -0
- visier_platform_sdk/models/report_delete_success_dto.py +88 -0
- visier_platform_sdk/models/report_dto.py +115 -0
- visier_platform_sdk/models/report_list_response_dto.py +96 -0
- visier_platform_sdk/models/result.py +96 -0
- visier_platform_sdk/models/role_modules_config_dto.py +88 -0
- visier_platform_sdk/models/salary_benchmark_input.py +100 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +96 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +106 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +110 -0
- visier_platform_sdk/models/salesforce_auth_params_dto.py +90 -0
- visier_platform_sdk/models/salesforce_v2_auth_params_dto.py +94 -0
- visier_platform_sdk/models/sample_question_api_response_dto.py +100 -0
- visier_platform_sdk/models/sample_questions_api_response_dto.py +96 -0
- visier_platform_sdk/models/scenario_info_dto.py +92 -0
- visier_platform_sdk/models/scenario_or_snapshot_dto.py +90 -0
- visier_platform_sdk/models/securable_dimension_dto.py +102 -0
- visier_platform_sdk/models/securable_property_dto.py +96 -0
- visier_platform_sdk/models/security_assignment_response_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_configuration_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_configuration_map_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_dto.py +106 -0
- visier_platform_sdk/models/selection_concept_list_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_reference_dto.py +90 -0
- visier_platform_sdk/models/selection_concepts_dto.py +96 -0
- visier_platform_sdk/models/service_now_auth_params_dto.py +92 -0
- visier_platform_sdk/models/service_now_v2_auth_params_dto.py +96 -0
- visier_platform_sdk/models/servicing_capability_proto_enum_access_lookup_dto.py +96 -0
- visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +92 -0
- visier_platform_sdk/models/set_connector_setting_request_dto.py +98 -0
- visier_platform_sdk/models/set_connector_setting_response_dto.py +112 -0
- visier_platform_sdk/models/set_connector_settings_request_dto.py +96 -0
- visier_platform_sdk/models/set_connector_settings_response_dto.py +96 -0
- visier_platform_sdk/models/shareable_data_access_set.py +88 -0
- visier_platform_sdk/models/simple_document_header_search_response_dto.py +96 -0
- visier_platform_sdk/models/simple_document_header_search_result_dto.py +98 -0
- visier_platform_sdk/models/simple_property_type_dto.py +88 -0
- visier_platform_sdk/models/simple_user_dto.py +90 -0
- visier_platform_sdk/models/skill.py +106 -0
- visier_platform_sdk/models/skill_category.py +102 -0
- visier_platform_sdk/models/skill_category_entry.py +92 -0
- visier_platform_sdk/models/skill_entry.py +92 -0
- visier_platform_sdk/models/skill_extraction_input.py +93 -0
- visier_platform_sdk/models/skill_group.py +104 -0
- visier_platform_sdk/models/skill_group_entry.py +92 -0
- visier_platform_sdk/models/skill_match_input.py +91 -0
- visier_platform_sdk/models/slack_auth_params_dto.py +92 -0
- visier_platform_sdk/models/snapshot_query_execution_dto.py +144 -0
- visier_platform_sdk/models/snapshot_query_execution_options_dto.py +134 -0
- visier_platform_sdk/models/snowflake_auth_params_dto.py +100 -0
- visier_platform_sdk/models/sort_option_dto.py +100 -0
- visier_platform_sdk/models/source.py +98 -0
- visier_platform_sdk/models/source_import_result_summary_dto.py +94 -0
- visier_platform_sdk/models/sources_api_operation_request_dto.py +104 -0
- visier_platform_sdk/models/sources_api_put_response_dto.py +92 -0
- visier_platform_sdk/models/sql_like200_response.py +138 -0
- visier_platform_sdk/models/sql_like_query_execution_dto.py +94 -0
- visier_platform_sdk/models/sql_server_auth_params_dto.py +96 -0
- visier_platform_sdk/models/start_extraction_response.py +88 -0
- visier_platform_sdk/models/start_transfer_response.py +88 -0
- visier_platform_sdk/models/static_dimension_filter_dto.py +112 -0
- visier_platform_sdk/models/status.py +96 -0
- visier_platform_sdk/models/subject_missing_access_dto.py +102 -0
- visier_platform_sdk/models/success_factors_auth_params_dto.py +100 -0
- visier_platform_sdk/models/success_factors_o_auth_params_dto.py +92 -0
- visier_platform_sdk/models/successful_accessible_tenant_profile_assignment_dto.py +92 -0
- visier_platform_sdk/models/successful_change_dto.py +98 -0
- visier_platform_sdk/models/successful_local_tenant_profile_assignment_dto.py +88 -0
- visier_platform_sdk/models/synonym_list_dto.py +88 -0
- visier_platform_sdk/models/system_status_dto.py +88 -0
- visier_platform_sdk/models/table_response_dto.py +90 -0
- visier_platform_sdk/models/tag_map_element_dto.py +90 -0
- visier_platform_sdk/models/tag_reference_dto.py +88 -0
- visier_platform_sdk/models/tag_reference_list_dto.py +96 -0
- visier_platform_sdk/models/tags_dto.py +88 -0
- visier_platform_sdk/models/target_project_for_tenant_dto.py +90 -0
- visier_platform_sdk/models/target_project_for_tenants_list_dto.py +96 -0
- visier_platform_sdk/models/target_tenant_code_dto.py +90 -0
- visier_platform_sdk/models/tenant.py +100 -0
- visier_platform_sdk/models/tenant_and_credential.py +90 -0
- visier_platform_sdk/models/tenant_assignments_dto.py +114 -0
- visier_platform_sdk/models/tenant_code_body.py +88 -0
- visier_platform_sdk/models/tenant_code_error_dto.py +96 -0
- visier_platform_sdk/models/tenant_connector_settings_request_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_upload_status_response_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_upload_update_status_response_dto.py +94 -0
- visier_platform_sdk/models/tenant_data_uploads_list_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_data_uploads_response_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_uploads_update_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_detail_apidto.py +130 -0
- visier_platform_sdk/models/tenant_details_traits_dto.py +112 -0
- visier_platform_sdk/models/tenant_encryption_key_details_dto.py +96 -0
- visier_platform_sdk/models/tenant_encryption_key_dto.py +94 -0
- visier_platform_sdk/models/tenant_management_api_get_response_dto.py +156 -0
- visier_platform_sdk/models/tenant_management_api_list_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_management_api_update_request_dto.py +156 -0
- visier_platform_sdk/models/tenant_management_api_update_response_dto.py +136 -0
- visier_platform_sdk/models/tenant_module_dto.py +96 -0
- visier_platform_sdk/models/tenant_preview_entries_summary_dto.py +102 -0
- visier_platform_sdk/models/tenant_preview_entries_summary_list_dto.py +100 -0
- visier_platform_sdk/models/tenant_provision_apidto.py +110 -0
- visier_platform_sdk/models/tenant_status_apidto.py +94 -0
- visier_platform_sdk/models/time_shift_dto.py +112 -0
- visier_platform_sdk/models/token_response.py +96 -0
- visier_platform_sdk/models/ultimate_auth_params_dto.py +96 -0
- visier_platform_sdk/models/update_tenant_model.py +98 -0
- visier_platform_sdk/models/upload_to_exclude.py +102 -0
- visier_platform_sdk/models/upload_to_include.py +102 -0
- visier_platform_sdk/models/user_creation_api_request_dto.py +96 -0
- visier_platform_sdk/models/user_creation_api_response_dto.py +98 -0
- visier_platform_sdk/models/user_get_api_response_dto.py +122 -0
- visier_platform_sdk/models/user_group_assigned_for_local_tenant_dto.py +90 -0
- visier_platform_sdk/models/user_group_assignment_dto.py +88 -0
- visier_platform_sdk/models/user_group_change_definition_dto.py +108 -0
- visier_platform_sdk/models/user_group_change_dimension_filter_dto.py +104 -0
- visier_platform_sdk/models/user_group_change_failure_dto.py +96 -0
- visier_platform_sdk/models/user_group_change_filter_dto.py +100 -0
- visier_platform_sdk/models/user_group_change_member_selection_dto.py +90 -0
- visier_platform_sdk/models/user_group_change_response_dto.py +106 -0
- visier_platform_sdk/models/user_group_change_success_dto.py +94 -0
- visier_platform_sdk/models/user_group_change_users_dto.py +105 -0
- visier_platform_sdk/models/user_group_delete_dto.py +92 -0
- visier_platform_sdk/models/user_group_delete_failure_dto.py +96 -0
- visier_platform_sdk/models/user_group_delete_response_dto.py +106 -0
- visier_platform_sdk/models/user_group_delete_success_dto.py +92 -0
- visier_platform_sdk/models/user_group_filters_dto.py +96 -0
- visier_platform_sdk/models/user_group_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/user_group_single_delete_response_dto.py +98 -0
- visier_platform_sdk/models/user_groups_change_dto.py +96 -0
- visier_platform_sdk/models/user_groups_delete_request_dto.py +96 -0
- visier_platform_sdk/models/user_groups_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/user_groups_users_dto.py +100 -0
- visier_platform_sdk/models/user_groups_users_for_tenant_dto.py +98 -0
- visier_platform_sdk/models/user_id_error_dto.py +94 -0
- visier_platform_sdk/models/user_property_dto.py +88 -0
- visier_platform_sdk/models/user_security_assignments_dto.py +100 -0
- visier_platform_sdk/models/user_update_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_api_error_message_dto.py +90 -0
- visier_platform_sdk/models/users_api_failure_dto.py +98 -0
- visier_platform_sdk/models/users_api_response_dto.py +106 -0
- visier_platform_sdk/models/users_api_success_dto.py +98 -0
- visier_platform_sdk/models/users_creation_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_delete_api_request_dto.py +88 -0
- visier_platform_sdk/models/users_to_user_group_request_dto.py +90 -0
- visier_platform_sdk/models/users_to_user_groups_request_dto.py +102 -0
- visier_platform_sdk/models/users_update_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_update_api_user_dto.py +98 -0
- visier_platform_sdk/models/v2_calculated_property_type_dto.py +92 -0
- visier_platform_sdk/models/v2_dimension_dto.py +118 -0
- visier_platform_sdk/models/v2_level_dto.py +102 -0
- visier_platform_sdk/models/v2_simple_property_type_dto.py +90 -0
- visier_platform_sdk/models/validity_range_dto.py +90 -0
- visier_platform_sdk/models/vee_clarification_dto.py +98 -0
- visier_platform_sdk/models/vee_conversation_dto.py +92 -0
- visier_platform_sdk/models/vee_conversation_state_dto.py +88 -0
- visier_platform_sdk/models/vee_corrections_dto.py +109 -0
- visier_platform_sdk/models/vee_data_dto.py +90 -0
- visier_platform_sdk/models/vee_feedback_dto.py +96 -0
- visier_platform_sdk/models/vee_options_dto.py +110 -0
- visier_platform_sdk/models/vee_question_change_definition_dto.py +100 -0
- visier_platform_sdk/models/vee_question_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/vee_question_change_failure_dto.py +106 -0
- visier_platform_sdk/models/vee_question_change_success_dto.py +104 -0
- visier_platform_sdk/models/vee_question_delete_definitions_by_tenant_dto.py +92 -0
- visier_platform_sdk/models/vee_question_dto.py +102 -0
- visier_platform_sdk/models/vee_questions_bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/vee_questions_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/vee_questions_delete_definitions_dto.py +96 -0
- visier_platform_sdk/models/vee_response_dto.py +132 -0
- visier_platform_sdk/models/vee_response_schema_dto.py +107 -0
- visier_platform_sdk/models/vee_response_schema_reference_dto.py +90 -0
- visier_platform_sdk/models/vee_sample_question_dto.py +94 -0
- visier_platform_sdk/models/vee_sample_question_library_dto.py +96 -0
- visier_platform_sdk/models/vee_status_code_dto.py +100 -0
- visier_platform_sdk/models/vee_status_dto.py +88 -0
- visier_platform_sdk/models/vee_visual_dto.py +92 -0
- visier_platform_sdk/models/vee_visual_options_dto.py +90 -0
- visier_platform_sdk/models/version_information_dto.py +102 -0
- visier_platform_sdk/models/webhook_basic_auth_credential_dto.py +90 -0
- visier_platform_sdk/models/webhook_credentials_dto.py +94 -0
- visier_platform_sdk/models/webhook_details_dto.py +104 -0
- visier_platform_sdk/models/webhook_dto.py +96 -0
- visier_platform_sdk/models/webhook_event_type_dto.py +88 -0
- visier_platform_sdk/models/webhook_message_response_dto.py +94 -0
- visier_platform_sdk/models/webhook_request_dto.py +98 -0
- visier_platform_sdk/models/webhooks_dto.py +96 -0
- visier_platform_sdk/models/willow_auth_params_dto.py +90 -0
- visier_platform_sdk/models/workday_auth_params_dto.py +118 -0
- visier_platform_sdk/models/workday_o_auth_params_dto.py +92 -0
- visier_platform_sdk/models/workday_raas_auth_params_dto.py +96 -0
- visier_platform_sdk/models/workday_refresh_token_params_dto.py +92 -0
- visier_platform_sdk/models/zoom_auth_params_dto.py +92 -0
- visier_platform_sdk/py.typed +0 -0
- visier_platform_sdk/rest.py +259 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/METADATA +28 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/RECORD +692 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/WHEEL +5 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1757 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
API Reference
|
|
5
|
+
|
|
6
|
+
Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 22222222.99200.21494
|
|
9
|
+
Contact: alpine@visier.com
|
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
|
+
|
|
12
|
+
Do not edit the class manually.
|
|
13
|
+
""" # noqa: E501
|
|
14
|
+
|
|
15
|
+
import warnings
|
|
16
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
17
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
18
|
+
from typing_extensions import Annotated
|
|
19
|
+
|
|
20
|
+
from pydantic import Field, StrictInt, StrictStr
|
|
21
|
+
from typing import Optional
|
|
22
|
+
from typing_extensions import Annotated
|
|
23
|
+
from visier_platform_sdk.models.report_create_request_dto import ReportCreateRequestDTO
|
|
24
|
+
from visier_platform_sdk.models.report_dto import ReportDTO
|
|
25
|
+
from visier_platform_sdk.models.report_delete_success_dto import ReportDeleteSuccessDTO
|
|
26
|
+
from visier_platform_sdk.models.report_list_response_dto import ReportListResponseDTO
|
|
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 ReportingApi:
|
|
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_report(
|
|
48
|
+
self,
|
|
49
|
+
report_create_request_dto: ReportCreateRequestDTO,
|
|
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
|
+
_request_timeout: Union[
|
|
52
|
+
None,
|
|
53
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
54
|
+
Tuple[
|
|
55
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
56
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
57
|
+
]
|
|
58
|
+
] = None,
|
|
59
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
60
|
+
_content_type: Optional[StrictStr] = None,
|
|
61
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
62
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
63
|
+
) -> ReportDTO:
|
|
64
|
+
"""Create a report
|
|
65
|
+
|
|
66
|
+
Create a new report with a title and description. To edit other contents of the report, such as columns and group bys, navigate to the Reports room in Visier. <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>
|
|
67
|
+
|
|
68
|
+
:param report_create_request_dto: (required)
|
|
69
|
+
:type report_create_request_dto: ReportCreateRequestDTO
|
|
70
|
+
: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.
|
|
71
|
+
:type target_tenant_id: str
|
|
72
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
73
|
+
number provided, it will be total request
|
|
74
|
+
timeout. It can also be a pair (tuple) of
|
|
75
|
+
(connection, read) timeouts.
|
|
76
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
77
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
78
|
+
request; this effectively ignores the
|
|
79
|
+
authentication in the spec for a single request.
|
|
80
|
+
:type _request_auth: dict, optional
|
|
81
|
+
:param _content_type: force content-type for the request.
|
|
82
|
+
:type _content_type: str, Optional
|
|
83
|
+
:param _headers: set to override the headers for a single
|
|
84
|
+
request; this effectively ignores the headers
|
|
85
|
+
in the spec for a single request.
|
|
86
|
+
:type _headers: dict, optional
|
|
87
|
+
:param _host_index: set to override the host_index for a single
|
|
88
|
+
request; this effectively ignores the host_index
|
|
89
|
+
in the spec for a single request.
|
|
90
|
+
:type _host_index: int, optional
|
|
91
|
+
:return: Returns the result object.
|
|
92
|
+
""" # noqa: E501
|
|
93
|
+
|
|
94
|
+
_param = self._create_report_serialize(
|
|
95
|
+
report_create_request_dto=report_create_request_dto,
|
|
96
|
+
target_tenant_id=target_tenant_id,
|
|
97
|
+
_request_auth=_request_auth,
|
|
98
|
+
_content_type=_content_type,
|
|
99
|
+
_headers=_headers,
|
|
100
|
+
_host_index=_host_index
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
104
|
+
'200': "ReportDTO",
|
|
105
|
+
}
|
|
106
|
+
response_data = self.api_client.call_api(
|
|
107
|
+
*_param,
|
|
108
|
+
_request_timeout=_request_timeout
|
|
109
|
+
)
|
|
110
|
+
response_data.read()
|
|
111
|
+
return self.api_client.response_deserialize(
|
|
112
|
+
response_data=response_data,
|
|
113
|
+
response_types_map=_response_types_map,
|
|
114
|
+
).data
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
@validate_call
|
|
118
|
+
def create_report_with_http_info(
|
|
119
|
+
self,
|
|
120
|
+
report_create_request_dto: ReportCreateRequestDTO,
|
|
121
|
+
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,
|
|
122
|
+
_request_timeout: Union[
|
|
123
|
+
None,
|
|
124
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
125
|
+
Tuple[
|
|
126
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
127
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
128
|
+
]
|
|
129
|
+
] = None,
|
|
130
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
131
|
+
_content_type: Optional[StrictStr] = None,
|
|
132
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
133
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
134
|
+
) -> ApiResponse[ReportDTO]:
|
|
135
|
+
"""Create a report
|
|
136
|
+
|
|
137
|
+
Create a new report with a title and description. To edit other contents of the report, such as columns and group bys, navigate to the Reports room in Visier. <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>
|
|
138
|
+
|
|
139
|
+
:param report_create_request_dto: (required)
|
|
140
|
+
:type report_create_request_dto: ReportCreateRequestDTO
|
|
141
|
+
: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.
|
|
142
|
+
:type target_tenant_id: str
|
|
143
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
144
|
+
number provided, it will be total request
|
|
145
|
+
timeout. It can also be a pair (tuple) of
|
|
146
|
+
(connection, read) timeouts.
|
|
147
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
148
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
149
|
+
request; this effectively ignores the
|
|
150
|
+
authentication in the spec for a single request.
|
|
151
|
+
:type _request_auth: dict, optional
|
|
152
|
+
:param _content_type: force content-type for the request.
|
|
153
|
+
:type _content_type: str, Optional
|
|
154
|
+
:param _headers: set to override the headers for a single
|
|
155
|
+
request; this effectively ignores the headers
|
|
156
|
+
in the spec for a single request.
|
|
157
|
+
:type _headers: dict, optional
|
|
158
|
+
:param _host_index: set to override the host_index for a single
|
|
159
|
+
request; this effectively ignores the host_index
|
|
160
|
+
in the spec for a single request.
|
|
161
|
+
:type _host_index: int, optional
|
|
162
|
+
:return: Returns the result object.
|
|
163
|
+
""" # noqa: E501
|
|
164
|
+
|
|
165
|
+
_param = self._create_report_serialize(
|
|
166
|
+
report_create_request_dto=report_create_request_dto,
|
|
167
|
+
target_tenant_id=target_tenant_id,
|
|
168
|
+
_request_auth=_request_auth,
|
|
169
|
+
_content_type=_content_type,
|
|
170
|
+
_headers=_headers,
|
|
171
|
+
_host_index=_host_index
|
|
172
|
+
)
|
|
173
|
+
|
|
174
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
175
|
+
'200': "ReportDTO",
|
|
176
|
+
}
|
|
177
|
+
response_data = self.api_client.call_api(
|
|
178
|
+
*_param,
|
|
179
|
+
_request_timeout=_request_timeout
|
|
180
|
+
)
|
|
181
|
+
response_data.read()
|
|
182
|
+
return self.api_client.response_deserialize(
|
|
183
|
+
response_data=response_data,
|
|
184
|
+
response_types_map=_response_types_map,
|
|
185
|
+
)
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
@validate_call
|
|
189
|
+
def create_report_without_preload_content(
|
|
190
|
+
self,
|
|
191
|
+
report_create_request_dto: ReportCreateRequestDTO,
|
|
192
|
+
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,
|
|
193
|
+
_request_timeout: Union[
|
|
194
|
+
None,
|
|
195
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
196
|
+
Tuple[
|
|
197
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
198
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
199
|
+
]
|
|
200
|
+
] = None,
|
|
201
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
202
|
+
_content_type: Optional[StrictStr] = None,
|
|
203
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
204
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
205
|
+
) -> RESTResponseType:
|
|
206
|
+
"""Create a report
|
|
207
|
+
|
|
208
|
+
Create a new report with a title and description. To edit other contents of the report, such as columns and group bys, navigate to the Reports room in Visier. <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>
|
|
209
|
+
|
|
210
|
+
:param report_create_request_dto: (required)
|
|
211
|
+
:type report_create_request_dto: ReportCreateRequestDTO
|
|
212
|
+
: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.
|
|
213
|
+
:type target_tenant_id: str
|
|
214
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
215
|
+
number provided, it will be total request
|
|
216
|
+
timeout. It can also be a pair (tuple) of
|
|
217
|
+
(connection, read) timeouts.
|
|
218
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
219
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
220
|
+
request; this effectively ignores the
|
|
221
|
+
authentication in the spec for a single request.
|
|
222
|
+
:type _request_auth: dict, optional
|
|
223
|
+
:param _content_type: force content-type for the request.
|
|
224
|
+
:type _content_type: str, Optional
|
|
225
|
+
:param _headers: set to override the headers for a single
|
|
226
|
+
request; this effectively ignores the headers
|
|
227
|
+
in the spec for a single request.
|
|
228
|
+
:type _headers: dict, optional
|
|
229
|
+
:param _host_index: set to override the host_index for a single
|
|
230
|
+
request; this effectively ignores the host_index
|
|
231
|
+
in the spec for a single request.
|
|
232
|
+
:type _host_index: int, optional
|
|
233
|
+
:return: Returns the result object.
|
|
234
|
+
""" # noqa: E501
|
|
235
|
+
|
|
236
|
+
_param = self._create_report_serialize(
|
|
237
|
+
report_create_request_dto=report_create_request_dto,
|
|
238
|
+
target_tenant_id=target_tenant_id,
|
|
239
|
+
_request_auth=_request_auth,
|
|
240
|
+
_content_type=_content_type,
|
|
241
|
+
_headers=_headers,
|
|
242
|
+
_host_index=_host_index
|
|
243
|
+
)
|
|
244
|
+
|
|
245
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
246
|
+
'200': "ReportDTO",
|
|
247
|
+
}
|
|
248
|
+
response_data = self.api_client.call_api(
|
|
249
|
+
*_param,
|
|
250
|
+
_request_timeout=_request_timeout
|
|
251
|
+
)
|
|
252
|
+
return response_data.response
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
def _create_report_serialize(
|
|
256
|
+
self,
|
|
257
|
+
report_create_request_dto,
|
|
258
|
+
target_tenant_id,
|
|
259
|
+
_request_auth,
|
|
260
|
+
_content_type,
|
|
261
|
+
_headers,
|
|
262
|
+
_host_index,
|
|
263
|
+
) -> RequestSerialized:
|
|
264
|
+
|
|
265
|
+
_host = None
|
|
266
|
+
|
|
267
|
+
_collection_formats: Dict[str, str] = {
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
_path_params: Dict[str, str] = {}
|
|
271
|
+
_query_params: List[Tuple[str, str]] = []
|
|
272
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
273
|
+
_form_params: List[Tuple[str, str]] = []
|
|
274
|
+
_files: Dict[
|
|
275
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
276
|
+
] = {}
|
|
277
|
+
_body_params: Optional[bytes] = None
|
|
278
|
+
|
|
279
|
+
# process the path parameters
|
|
280
|
+
# process the query parameters
|
|
281
|
+
# process the header parameters
|
|
282
|
+
if target_tenant_id is not None:
|
|
283
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
284
|
+
# process the form parameters
|
|
285
|
+
# process the body parameter
|
|
286
|
+
if report_create_request_dto is not None:
|
|
287
|
+
_body_params = report_create_request_dto
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
# set the HTTP header `Accept`
|
|
291
|
+
if 'Accept' not in _header_params:
|
|
292
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
293
|
+
[
|
|
294
|
+
'application/json'
|
|
295
|
+
]
|
|
296
|
+
)
|
|
297
|
+
|
|
298
|
+
# set the HTTP header `Content-Type`
|
|
299
|
+
if _content_type:
|
|
300
|
+
_header_params['Content-Type'] = _content_type
|
|
301
|
+
else:
|
|
302
|
+
_default_content_type = (
|
|
303
|
+
self.api_client.select_header_content_type(
|
|
304
|
+
[
|
|
305
|
+
'application/json'
|
|
306
|
+
]
|
|
307
|
+
)
|
|
308
|
+
)
|
|
309
|
+
if _default_content_type is not None:
|
|
310
|
+
_header_params['Content-Type'] = _default_content_type
|
|
311
|
+
|
|
312
|
+
# authentication setting
|
|
313
|
+
_auth_settings: List[str] = [
|
|
314
|
+
'CookieAuth',
|
|
315
|
+
'ApiKeyAuth',
|
|
316
|
+
'OAuth2Auth',
|
|
317
|
+
'OAuth2Auth',
|
|
318
|
+
'BearerAuth'
|
|
319
|
+
]
|
|
320
|
+
|
|
321
|
+
return self.api_client.param_serialize(
|
|
322
|
+
method='POST',
|
|
323
|
+
resource_path='/v1alpha/reporting/reports',
|
|
324
|
+
path_params=_path_params,
|
|
325
|
+
query_params=_query_params,
|
|
326
|
+
header_params=_header_params,
|
|
327
|
+
body=_body_params,
|
|
328
|
+
post_params=_form_params,
|
|
329
|
+
files=_files,
|
|
330
|
+
auth_settings=_auth_settings,
|
|
331
|
+
collection_formats=_collection_formats,
|
|
332
|
+
_host=_host,
|
|
333
|
+
_request_auth=_request_auth
|
|
334
|
+
)
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
@validate_call
|
|
340
|
+
def delete_report(
|
|
341
|
+
self,
|
|
342
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")],
|
|
343
|
+
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,
|
|
344
|
+
_request_timeout: Union[
|
|
345
|
+
None,
|
|
346
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
347
|
+
Tuple[
|
|
348
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
349
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
350
|
+
]
|
|
351
|
+
] = None,
|
|
352
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
353
|
+
_content_type: Optional[StrictStr] = None,
|
|
354
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
355
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
356
|
+
) -> ReportDeleteSuccessDTO:
|
|
357
|
+
"""Delete a report
|
|
358
|
+
|
|
359
|
+
Delete a report in the tenant. You must know the ID of the report to delete it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
360
|
+
|
|
361
|
+
:param report_id: The unique identifier of the report you want to delete. (required)
|
|
362
|
+
:type report_id: str
|
|
363
|
+
: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.
|
|
364
|
+
:type target_tenant_id: str
|
|
365
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
366
|
+
number provided, it will be total request
|
|
367
|
+
timeout. It can also be a pair (tuple) of
|
|
368
|
+
(connection, read) timeouts.
|
|
369
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
370
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
371
|
+
request; this effectively ignores the
|
|
372
|
+
authentication in the spec for a single request.
|
|
373
|
+
:type _request_auth: dict, optional
|
|
374
|
+
:param _content_type: force content-type for the request.
|
|
375
|
+
:type _content_type: str, Optional
|
|
376
|
+
:param _headers: set to override the headers for a single
|
|
377
|
+
request; this effectively ignores the headers
|
|
378
|
+
in the spec for a single request.
|
|
379
|
+
:type _headers: dict, optional
|
|
380
|
+
:param _host_index: set to override the host_index for a single
|
|
381
|
+
request; this effectively ignores the host_index
|
|
382
|
+
in the spec for a single request.
|
|
383
|
+
:type _host_index: int, optional
|
|
384
|
+
:return: Returns the result object.
|
|
385
|
+
""" # noqa: E501
|
|
386
|
+
|
|
387
|
+
_param = self._delete_report_serialize(
|
|
388
|
+
report_id=report_id,
|
|
389
|
+
target_tenant_id=target_tenant_id,
|
|
390
|
+
_request_auth=_request_auth,
|
|
391
|
+
_content_type=_content_type,
|
|
392
|
+
_headers=_headers,
|
|
393
|
+
_host_index=_host_index
|
|
394
|
+
)
|
|
395
|
+
|
|
396
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
397
|
+
'200': "ReportDeleteSuccessDTO",
|
|
398
|
+
}
|
|
399
|
+
response_data = self.api_client.call_api(
|
|
400
|
+
*_param,
|
|
401
|
+
_request_timeout=_request_timeout
|
|
402
|
+
)
|
|
403
|
+
response_data.read()
|
|
404
|
+
return self.api_client.response_deserialize(
|
|
405
|
+
response_data=response_data,
|
|
406
|
+
response_types_map=_response_types_map,
|
|
407
|
+
).data
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
@validate_call
|
|
411
|
+
def delete_report_with_http_info(
|
|
412
|
+
self,
|
|
413
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")],
|
|
414
|
+
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,
|
|
415
|
+
_request_timeout: Union[
|
|
416
|
+
None,
|
|
417
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
418
|
+
Tuple[
|
|
419
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
420
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
421
|
+
]
|
|
422
|
+
] = None,
|
|
423
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
424
|
+
_content_type: Optional[StrictStr] = None,
|
|
425
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
426
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
427
|
+
) -> ApiResponse[ReportDeleteSuccessDTO]:
|
|
428
|
+
"""Delete a report
|
|
429
|
+
|
|
430
|
+
Delete a report in the tenant. You must know the ID of the report to delete it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
431
|
+
|
|
432
|
+
:param report_id: The unique identifier of the report you want to delete. (required)
|
|
433
|
+
:type report_id: str
|
|
434
|
+
: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.
|
|
435
|
+
:type target_tenant_id: str
|
|
436
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
437
|
+
number provided, it will be total request
|
|
438
|
+
timeout. It can also be a pair (tuple) of
|
|
439
|
+
(connection, read) timeouts.
|
|
440
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
441
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
442
|
+
request; this effectively ignores the
|
|
443
|
+
authentication in the spec for a single request.
|
|
444
|
+
:type _request_auth: dict, optional
|
|
445
|
+
:param _content_type: force content-type for the request.
|
|
446
|
+
:type _content_type: str, Optional
|
|
447
|
+
:param _headers: set to override the headers for a single
|
|
448
|
+
request; this effectively ignores the headers
|
|
449
|
+
in the spec for a single request.
|
|
450
|
+
:type _headers: dict, optional
|
|
451
|
+
:param _host_index: set to override the host_index for a single
|
|
452
|
+
request; this effectively ignores the host_index
|
|
453
|
+
in the spec for a single request.
|
|
454
|
+
:type _host_index: int, optional
|
|
455
|
+
:return: Returns the result object.
|
|
456
|
+
""" # noqa: E501
|
|
457
|
+
|
|
458
|
+
_param = self._delete_report_serialize(
|
|
459
|
+
report_id=report_id,
|
|
460
|
+
target_tenant_id=target_tenant_id,
|
|
461
|
+
_request_auth=_request_auth,
|
|
462
|
+
_content_type=_content_type,
|
|
463
|
+
_headers=_headers,
|
|
464
|
+
_host_index=_host_index
|
|
465
|
+
)
|
|
466
|
+
|
|
467
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
468
|
+
'200': "ReportDeleteSuccessDTO",
|
|
469
|
+
}
|
|
470
|
+
response_data = self.api_client.call_api(
|
|
471
|
+
*_param,
|
|
472
|
+
_request_timeout=_request_timeout
|
|
473
|
+
)
|
|
474
|
+
response_data.read()
|
|
475
|
+
return self.api_client.response_deserialize(
|
|
476
|
+
response_data=response_data,
|
|
477
|
+
response_types_map=_response_types_map,
|
|
478
|
+
)
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
@validate_call
|
|
482
|
+
def delete_report_without_preload_content(
|
|
483
|
+
self,
|
|
484
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")],
|
|
485
|
+
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,
|
|
486
|
+
_request_timeout: Union[
|
|
487
|
+
None,
|
|
488
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
489
|
+
Tuple[
|
|
490
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
491
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
492
|
+
]
|
|
493
|
+
] = None,
|
|
494
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
495
|
+
_content_type: Optional[StrictStr] = None,
|
|
496
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
497
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
498
|
+
) -> RESTResponseType:
|
|
499
|
+
"""Delete a report
|
|
500
|
+
|
|
501
|
+
Delete a report in the tenant. You must know the ID of the report to delete it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
502
|
+
|
|
503
|
+
:param report_id: The unique identifier of the report you want to delete. (required)
|
|
504
|
+
:type report_id: str
|
|
505
|
+
: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.
|
|
506
|
+
:type target_tenant_id: str
|
|
507
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
508
|
+
number provided, it will be total request
|
|
509
|
+
timeout. It can also be a pair (tuple) of
|
|
510
|
+
(connection, read) timeouts.
|
|
511
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
512
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
513
|
+
request; this effectively ignores the
|
|
514
|
+
authentication in the spec for a single request.
|
|
515
|
+
:type _request_auth: dict, optional
|
|
516
|
+
:param _content_type: force content-type for the request.
|
|
517
|
+
:type _content_type: str, Optional
|
|
518
|
+
:param _headers: set to override the headers for a single
|
|
519
|
+
request; this effectively ignores the headers
|
|
520
|
+
in the spec for a single request.
|
|
521
|
+
:type _headers: dict, optional
|
|
522
|
+
:param _host_index: set to override the host_index for a single
|
|
523
|
+
request; this effectively ignores the host_index
|
|
524
|
+
in the spec for a single request.
|
|
525
|
+
:type _host_index: int, optional
|
|
526
|
+
:return: Returns the result object.
|
|
527
|
+
""" # noqa: E501
|
|
528
|
+
|
|
529
|
+
_param = self._delete_report_serialize(
|
|
530
|
+
report_id=report_id,
|
|
531
|
+
target_tenant_id=target_tenant_id,
|
|
532
|
+
_request_auth=_request_auth,
|
|
533
|
+
_content_type=_content_type,
|
|
534
|
+
_headers=_headers,
|
|
535
|
+
_host_index=_host_index
|
|
536
|
+
)
|
|
537
|
+
|
|
538
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
539
|
+
'200': "ReportDeleteSuccessDTO",
|
|
540
|
+
}
|
|
541
|
+
response_data = self.api_client.call_api(
|
|
542
|
+
*_param,
|
|
543
|
+
_request_timeout=_request_timeout
|
|
544
|
+
)
|
|
545
|
+
return response_data.response
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
def _delete_report_serialize(
|
|
549
|
+
self,
|
|
550
|
+
report_id,
|
|
551
|
+
target_tenant_id,
|
|
552
|
+
_request_auth,
|
|
553
|
+
_content_type,
|
|
554
|
+
_headers,
|
|
555
|
+
_host_index,
|
|
556
|
+
) -> RequestSerialized:
|
|
557
|
+
|
|
558
|
+
_host = None
|
|
559
|
+
|
|
560
|
+
_collection_formats: Dict[str, str] = {
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
_path_params: Dict[str, str] = {}
|
|
564
|
+
_query_params: List[Tuple[str, str]] = []
|
|
565
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
566
|
+
_form_params: List[Tuple[str, str]] = []
|
|
567
|
+
_files: Dict[
|
|
568
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
569
|
+
] = {}
|
|
570
|
+
_body_params: Optional[bytes] = None
|
|
571
|
+
|
|
572
|
+
# process the path parameters
|
|
573
|
+
if report_id is not None:
|
|
574
|
+
_path_params['reportId'] = report_id
|
|
575
|
+
# process the query parameters
|
|
576
|
+
# process the header parameters
|
|
577
|
+
if target_tenant_id is not None:
|
|
578
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
579
|
+
# process the form parameters
|
|
580
|
+
# process the body parameter
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
# set the HTTP header `Accept`
|
|
584
|
+
if 'Accept' not in _header_params:
|
|
585
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
586
|
+
[
|
|
587
|
+
'application/json'
|
|
588
|
+
]
|
|
589
|
+
)
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
# authentication setting
|
|
593
|
+
_auth_settings: List[str] = [
|
|
594
|
+
'CookieAuth',
|
|
595
|
+
'ApiKeyAuth',
|
|
596
|
+
'OAuth2Auth',
|
|
597
|
+
'OAuth2Auth',
|
|
598
|
+
'BearerAuth'
|
|
599
|
+
]
|
|
600
|
+
|
|
601
|
+
return self.api_client.param_serialize(
|
|
602
|
+
method='DELETE',
|
|
603
|
+
resource_path='/v1alpha/reporting/reports/{reportId}',
|
|
604
|
+
path_params=_path_params,
|
|
605
|
+
query_params=_query_params,
|
|
606
|
+
header_params=_header_params,
|
|
607
|
+
body=_body_params,
|
|
608
|
+
post_params=_form_params,
|
|
609
|
+
files=_files,
|
|
610
|
+
auth_settings=_auth_settings,
|
|
611
|
+
collection_formats=_collection_formats,
|
|
612
|
+
_host=_host,
|
|
613
|
+
_request_auth=_request_auth
|
|
614
|
+
)
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
@validate_call
|
|
620
|
+
def download_report(
|
|
621
|
+
self,
|
|
622
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")],
|
|
623
|
+
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,
|
|
624
|
+
_request_timeout: Union[
|
|
625
|
+
None,
|
|
626
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
627
|
+
Tuple[
|
|
628
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
629
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
630
|
+
]
|
|
631
|
+
] = None,
|
|
632
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
633
|
+
_content_type: Optional[StrictStr] = None,
|
|
634
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
635
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
636
|
+
) -> str:
|
|
637
|
+
"""Download a report
|
|
638
|
+
|
|
639
|
+
Download a report as a CSV file. The returned CSV file contains the data in the report. You must know the ID of the report to download it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
640
|
+
|
|
641
|
+
:param report_id: The unique identifier of the report you want to download. (required)
|
|
642
|
+
:type report_id: str
|
|
643
|
+
: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.
|
|
644
|
+
:type target_tenant_id: str
|
|
645
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
646
|
+
number provided, it will be total request
|
|
647
|
+
timeout. It can also be a pair (tuple) of
|
|
648
|
+
(connection, read) timeouts.
|
|
649
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
650
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
651
|
+
request; this effectively ignores the
|
|
652
|
+
authentication in the spec for a single request.
|
|
653
|
+
:type _request_auth: dict, optional
|
|
654
|
+
:param _content_type: force content-type for the request.
|
|
655
|
+
:type _content_type: str, Optional
|
|
656
|
+
:param _headers: set to override the headers for a single
|
|
657
|
+
request; this effectively ignores the headers
|
|
658
|
+
in the spec for a single request.
|
|
659
|
+
:type _headers: dict, optional
|
|
660
|
+
:param _host_index: set to override the host_index for a single
|
|
661
|
+
request; this effectively ignores the host_index
|
|
662
|
+
in the spec for a single request.
|
|
663
|
+
:type _host_index: int, optional
|
|
664
|
+
:return: Returns the result object.
|
|
665
|
+
""" # noqa: E501
|
|
666
|
+
|
|
667
|
+
_param = self._download_report_serialize(
|
|
668
|
+
report_id=report_id,
|
|
669
|
+
target_tenant_id=target_tenant_id,
|
|
670
|
+
_request_auth=_request_auth,
|
|
671
|
+
_content_type=_content_type,
|
|
672
|
+
_headers=_headers,
|
|
673
|
+
_host_index=_host_index
|
|
674
|
+
)
|
|
675
|
+
|
|
676
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
677
|
+
'200': "str",
|
|
678
|
+
}
|
|
679
|
+
response_data = self.api_client.call_api(
|
|
680
|
+
*_param,
|
|
681
|
+
_request_timeout=_request_timeout
|
|
682
|
+
)
|
|
683
|
+
response_data.read()
|
|
684
|
+
return self.api_client.response_deserialize(
|
|
685
|
+
response_data=response_data,
|
|
686
|
+
response_types_map=_response_types_map,
|
|
687
|
+
).data
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
@validate_call
|
|
691
|
+
def download_report_with_http_info(
|
|
692
|
+
self,
|
|
693
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")],
|
|
694
|
+
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,
|
|
695
|
+
_request_timeout: Union[
|
|
696
|
+
None,
|
|
697
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
698
|
+
Tuple[
|
|
699
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
700
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
701
|
+
]
|
|
702
|
+
] = None,
|
|
703
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
704
|
+
_content_type: Optional[StrictStr] = None,
|
|
705
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
706
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
707
|
+
) -> ApiResponse[str]:
|
|
708
|
+
"""Download a report
|
|
709
|
+
|
|
710
|
+
Download a report as a CSV file. The returned CSV file contains the data in the report. You must know the ID of the report to download it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
711
|
+
|
|
712
|
+
:param report_id: The unique identifier of the report you want to download. (required)
|
|
713
|
+
:type report_id: str
|
|
714
|
+
: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.
|
|
715
|
+
:type target_tenant_id: str
|
|
716
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
717
|
+
number provided, it will be total request
|
|
718
|
+
timeout. It can also be a pair (tuple) of
|
|
719
|
+
(connection, read) timeouts.
|
|
720
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
721
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
722
|
+
request; this effectively ignores the
|
|
723
|
+
authentication in the spec for a single request.
|
|
724
|
+
:type _request_auth: dict, optional
|
|
725
|
+
:param _content_type: force content-type for the request.
|
|
726
|
+
:type _content_type: str, Optional
|
|
727
|
+
:param _headers: set to override the headers for a single
|
|
728
|
+
request; this effectively ignores the headers
|
|
729
|
+
in the spec for a single request.
|
|
730
|
+
:type _headers: dict, optional
|
|
731
|
+
:param _host_index: set to override the host_index for a single
|
|
732
|
+
request; this effectively ignores the host_index
|
|
733
|
+
in the spec for a single request.
|
|
734
|
+
:type _host_index: int, optional
|
|
735
|
+
:return: Returns the result object.
|
|
736
|
+
""" # noqa: E501
|
|
737
|
+
|
|
738
|
+
_param = self._download_report_serialize(
|
|
739
|
+
report_id=report_id,
|
|
740
|
+
target_tenant_id=target_tenant_id,
|
|
741
|
+
_request_auth=_request_auth,
|
|
742
|
+
_content_type=_content_type,
|
|
743
|
+
_headers=_headers,
|
|
744
|
+
_host_index=_host_index
|
|
745
|
+
)
|
|
746
|
+
|
|
747
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
748
|
+
'200': "str",
|
|
749
|
+
}
|
|
750
|
+
response_data = self.api_client.call_api(
|
|
751
|
+
*_param,
|
|
752
|
+
_request_timeout=_request_timeout
|
|
753
|
+
)
|
|
754
|
+
response_data.read()
|
|
755
|
+
return self.api_client.response_deserialize(
|
|
756
|
+
response_data=response_data,
|
|
757
|
+
response_types_map=_response_types_map,
|
|
758
|
+
)
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
@validate_call
|
|
762
|
+
def download_report_without_preload_content(
|
|
763
|
+
self,
|
|
764
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")],
|
|
765
|
+
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,
|
|
766
|
+
_request_timeout: Union[
|
|
767
|
+
None,
|
|
768
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
769
|
+
Tuple[
|
|
770
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
771
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
772
|
+
]
|
|
773
|
+
] = None,
|
|
774
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
775
|
+
_content_type: Optional[StrictStr] = None,
|
|
776
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
777
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
778
|
+
) -> RESTResponseType:
|
|
779
|
+
"""Download a report
|
|
780
|
+
|
|
781
|
+
Download a report as a CSV file. The returned CSV file contains the data in the report. You must know the ID of the report to download it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
782
|
+
|
|
783
|
+
:param report_id: The unique identifier of the report you want to download. (required)
|
|
784
|
+
:type report_id: str
|
|
785
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
786
|
+
:type target_tenant_id: str
|
|
787
|
+
:param _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._download_report_serialize(
|
|
810
|
+
report_id=report_id,
|
|
811
|
+
target_tenant_id=target_tenant_id,
|
|
812
|
+
_request_auth=_request_auth,
|
|
813
|
+
_content_type=_content_type,
|
|
814
|
+
_headers=_headers,
|
|
815
|
+
_host_index=_host_index
|
|
816
|
+
)
|
|
817
|
+
|
|
818
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
819
|
+
'200': "str",
|
|
820
|
+
}
|
|
821
|
+
response_data = self.api_client.call_api(
|
|
822
|
+
*_param,
|
|
823
|
+
_request_timeout=_request_timeout
|
|
824
|
+
)
|
|
825
|
+
return response_data.response
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
def _download_report_serialize(
|
|
829
|
+
self,
|
|
830
|
+
report_id,
|
|
831
|
+
target_tenant_id,
|
|
832
|
+
_request_auth,
|
|
833
|
+
_content_type,
|
|
834
|
+
_headers,
|
|
835
|
+
_host_index,
|
|
836
|
+
) -> RequestSerialized:
|
|
837
|
+
|
|
838
|
+
_host = None
|
|
839
|
+
|
|
840
|
+
_collection_formats: Dict[str, str] = {
|
|
841
|
+
}
|
|
842
|
+
|
|
843
|
+
_path_params: Dict[str, str] = {}
|
|
844
|
+
_query_params: List[Tuple[str, str]] = []
|
|
845
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
846
|
+
_form_params: List[Tuple[str, str]] = []
|
|
847
|
+
_files: Dict[
|
|
848
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
849
|
+
] = {}
|
|
850
|
+
_body_params: Optional[bytes] = None
|
|
851
|
+
|
|
852
|
+
# process the path parameters
|
|
853
|
+
if report_id is not None:
|
|
854
|
+
_path_params['reportId'] = report_id
|
|
855
|
+
# process the query parameters
|
|
856
|
+
# process the header parameters
|
|
857
|
+
if target_tenant_id is not None:
|
|
858
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
859
|
+
# process the form parameters
|
|
860
|
+
# process the body parameter
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
# set the HTTP header `Accept`
|
|
864
|
+
if 'Accept' not in _header_params:
|
|
865
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
866
|
+
[
|
|
867
|
+
'text/csv',
|
|
868
|
+
'application/zip',
|
|
869
|
+
'application/json'
|
|
870
|
+
]
|
|
871
|
+
)
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
# authentication setting
|
|
875
|
+
_auth_settings: List[str] = [
|
|
876
|
+
'CookieAuth',
|
|
877
|
+
'ApiKeyAuth',
|
|
878
|
+
'OAuth2Auth',
|
|
879
|
+
'OAuth2Auth',
|
|
880
|
+
'BearerAuth'
|
|
881
|
+
]
|
|
882
|
+
|
|
883
|
+
return self.api_client.param_serialize(
|
|
884
|
+
method='GET',
|
|
885
|
+
resource_path='/v1alpha/reporting/report-data/{reportId}',
|
|
886
|
+
path_params=_path_params,
|
|
887
|
+
query_params=_query_params,
|
|
888
|
+
header_params=_header_params,
|
|
889
|
+
body=_body_params,
|
|
890
|
+
post_params=_form_params,
|
|
891
|
+
files=_files,
|
|
892
|
+
auth_settings=_auth_settings,
|
|
893
|
+
collection_formats=_collection_formats,
|
|
894
|
+
_host=_host,
|
|
895
|
+
_request_auth=_request_auth
|
|
896
|
+
)
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
@validate_call
|
|
902
|
+
def duplicate_report(
|
|
903
|
+
self,
|
|
904
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")],
|
|
905
|
+
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,
|
|
906
|
+
_request_timeout: Union[
|
|
907
|
+
None,
|
|
908
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
909
|
+
Tuple[
|
|
910
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
911
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
912
|
+
]
|
|
913
|
+
] = None,
|
|
914
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
915
|
+
_content_type: Optional[StrictStr] = None,
|
|
916
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
917
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
918
|
+
) -> ReportDTO:
|
|
919
|
+
"""Duplicate a report
|
|
920
|
+
|
|
921
|
+
Make a copy of an existing report. You must know the ID of the report to copy it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
922
|
+
|
|
923
|
+
:param report_id: The unique identifier of the report you want to duplicate. (required)
|
|
924
|
+
:type report_id: str
|
|
925
|
+
: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.
|
|
926
|
+
:type target_tenant_id: str
|
|
927
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
928
|
+
number provided, it will be total request
|
|
929
|
+
timeout. It can also be a pair (tuple) of
|
|
930
|
+
(connection, read) timeouts.
|
|
931
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
932
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
933
|
+
request; this effectively ignores the
|
|
934
|
+
authentication in the spec for a single request.
|
|
935
|
+
:type _request_auth: dict, optional
|
|
936
|
+
:param _content_type: force content-type for the request.
|
|
937
|
+
:type _content_type: str, Optional
|
|
938
|
+
:param _headers: set to override the headers for a single
|
|
939
|
+
request; this effectively ignores the headers
|
|
940
|
+
in the spec for a single request.
|
|
941
|
+
:type _headers: dict, optional
|
|
942
|
+
:param _host_index: set to override the host_index for a single
|
|
943
|
+
request; this effectively ignores the host_index
|
|
944
|
+
in the spec for a single request.
|
|
945
|
+
:type _host_index: int, optional
|
|
946
|
+
:return: Returns the result object.
|
|
947
|
+
""" # noqa: E501
|
|
948
|
+
|
|
949
|
+
_param = self._duplicate_report_serialize(
|
|
950
|
+
report_id=report_id,
|
|
951
|
+
target_tenant_id=target_tenant_id,
|
|
952
|
+
_request_auth=_request_auth,
|
|
953
|
+
_content_type=_content_type,
|
|
954
|
+
_headers=_headers,
|
|
955
|
+
_host_index=_host_index
|
|
956
|
+
)
|
|
957
|
+
|
|
958
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
959
|
+
'200': "ReportDTO",
|
|
960
|
+
}
|
|
961
|
+
response_data = self.api_client.call_api(
|
|
962
|
+
*_param,
|
|
963
|
+
_request_timeout=_request_timeout
|
|
964
|
+
)
|
|
965
|
+
response_data.read()
|
|
966
|
+
return self.api_client.response_deserialize(
|
|
967
|
+
response_data=response_data,
|
|
968
|
+
response_types_map=_response_types_map,
|
|
969
|
+
).data
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
@validate_call
|
|
973
|
+
def duplicate_report_with_http_info(
|
|
974
|
+
self,
|
|
975
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")],
|
|
976
|
+
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,
|
|
977
|
+
_request_timeout: Union[
|
|
978
|
+
None,
|
|
979
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
980
|
+
Tuple[
|
|
981
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
982
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
983
|
+
]
|
|
984
|
+
] = None,
|
|
985
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
986
|
+
_content_type: Optional[StrictStr] = None,
|
|
987
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
988
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
989
|
+
) -> ApiResponse[ReportDTO]:
|
|
990
|
+
"""Duplicate a report
|
|
991
|
+
|
|
992
|
+
Make a copy of an existing report. You must know the ID of the report to copy it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
993
|
+
|
|
994
|
+
:param report_id: The unique identifier of the report you want to duplicate. (required)
|
|
995
|
+
:type report_id: str
|
|
996
|
+
: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.
|
|
997
|
+
:type target_tenant_id: str
|
|
998
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
999
|
+
number provided, it will be total request
|
|
1000
|
+
timeout. It can also be a pair (tuple) of
|
|
1001
|
+
(connection, read) timeouts.
|
|
1002
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1003
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1004
|
+
request; this effectively ignores the
|
|
1005
|
+
authentication in the spec for a single request.
|
|
1006
|
+
:type _request_auth: dict, optional
|
|
1007
|
+
:param _content_type: force content-type for the request.
|
|
1008
|
+
:type _content_type: str, Optional
|
|
1009
|
+
:param _headers: set to override the headers for a single
|
|
1010
|
+
request; this effectively ignores the headers
|
|
1011
|
+
in the spec for a single request.
|
|
1012
|
+
:type _headers: dict, optional
|
|
1013
|
+
:param _host_index: set to override the host_index for a single
|
|
1014
|
+
request; this effectively ignores the host_index
|
|
1015
|
+
in the spec for a single request.
|
|
1016
|
+
:type _host_index: int, optional
|
|
1017
|
+
:return: Returns the result object.
|
|
1018
|
+
""" # noqa: E501
|
|
1019
|
+
|
|
1020
|
+
_param = self._duplicate_report_serialize(
|
|
1021
|
+
report_id=report_id,
|
|
1022
|
+
target_tenant_id=target_tenant_id,
|
|
1023
|
+
_request_auth=_request_auth,
|
|
1024
|
+
_content_type=_content_type,
|
|
1025
|
+
_headers=_headers,
|
|
1026
|
+
_host_index=_host_index
|
|
1027
|
+
)
|
|
1028
|
+
|
|
1029
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1030
|
+
'200': "ReportDTO",
|
|
1031
|
+
}
|
|
1032
|
+
response_data = self.api_client.call_api(
|
|
1033
|
+
*_param,
|
|
1034
|
+
_request_timeout=_request_timeout
|
|
1035
|
+
)
|
|
1036
|
+
response_data.read()
|
|
1037
|
+
return self.api_client.response_deserialize(
|
|
1038
|
+
response_data=response_data,
|
|
1039
|
+
response_types_map=_response_types_map,
|
|
1040
|
+
)
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
@validate_call
|
|
1044
|
+
def duplicate_report_without_preload_content(
|
|
1045
|
+
self,
|
|
1046
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")],
|
|
1047
|
+
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,
|
|
1048
|
+
_request_timeout: Union[
|
|
1049
|
+
None,
|
|
1050
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1051
|
+
Tuple[
|
|
1052
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1053
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1054
|
+
]
|
|
1055
|
+
] = None,
|
|
1056
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1057
|
+
_content_type: Optional[StrictStr] = None,
|
|
1058
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1059
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1060
|
+
) -> RESTResponseType:
|
|
1061
|
+
"""Duplicate a report
|
|
1062
|
+
|
|
1063
|
+
Make a copy of an existing report. You must know the ID of the report to copy it. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
1064
|
+
|
|
1065
|
+
:param report_id: The unique identifier of the report you want to duplicate. (required)
|
|
1066
|
+
:type report_id: str
|
|
1067
|
+
: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.
|
|
1068
|
+
:type target_tenant_id: str
|
|
1069
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1070
|
+
number provided, it will be total request
|
|
1071
|
+
timeout. It can also be a pair (tuple) of
|
|
1072
|
+
(connection, read) timeouts.
|
|
1073
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1074
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1075
|
+
request; this effectively ignores the
|
|
1076
|
+
authentication in the spec for a single request.
|
|
1077
|
+
:type _request_auth: dict, optional
|
|
1078
|
+
:param _content_type: force content-type for the request.
|
|
1079
|
+
:type _content_type: str, Optional
|
|
1080
|
+
:param _headers: set to override the headers for a single
|
|
1081
|
+
request; this effectively ignores the headers
|
|
1082
|
+
in the spec for a single request.
|
|
1083
|
+
:type _headers: dict, optional
|
|
1084
|
+
:param _host_index: set to override the host_index for a single
|
|
1085
|
+
request; this effectively ignores the host_index
|
|
1086
|
+
in the spec for a single request.
|
|
1087
|
+
:type _host_index: int, optional
|
|
1088
|
+
:return: Returns the result object.
|
|
1089
|
+
""" # noqa: E501
|
|
1090
|
+
|
|
1091
|
+
_param = self._duplicate_report_serialize(
|
|
1092
|
+
report_id=report_id,
|
|
1093
|
+
target_tenant_id=target_tenant_id,
|
|
1094
|
+
_request_auth=_request_auth,
|
|
1095
|
+
_content_type=_content_type,
|
|
1096
|
+
_headers=_headers,
|
|
1097
|
+
_host_index=_host_index
|
|
1098
|
+
)
|
|
1099
|
+
|
|
1100
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1101
|
+
'200': "ReportDTO",
|
|
1102
|
+
}
|
|
1103
|
+
response_data = self.api_client.call_api(
|
|
1104
|
+
*_param,
|
|
1105
|
+
_request_timeout=_request_timeout
|
|
1106
|
+
)
|
|
1107
|
+
return response_data.response
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
def _duplicate_report_serialize(
|
|
1111
|
+
self,
|
|
1112
|
+
report_id,
|
|
1113
|
+
target_tenant_id,
|
|
1114
|
+
_request_auth,
|
|
1115
|
+
_content_type,
|
|
1116
|
+
_headers,
|
|
1117
|
+
_host_index,
|
|
1118
|
+
) -> RequestSerialized:
|
|
1119
|
+
|
|
1120
|
+
_host = None
|
|
1121
|
+
|
|
1122
|
+
_collection_formats: Dict[str, str] = {
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
_path_params: Dict[str, str] = {}
|
|
1126
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1127
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1128
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1129
|
+
_files: Dict[
|
|
1130
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1131
|
+
] = {}
|
|
1132
|
+
_body_params: Optional[bytes] = None
|
|
1133
|
+
|
|
1134
|
+
# process the path parameters
|
|
1135
|
+
if report_id is not None:
|
|
1136
|
+
_path_params['reportId'] = report_id
|
|
1137
|
+
# process the query parameters
|
|
1138
|
+
# process the header parameters
|
|
1139
|
+
if target_tenant_id is not None:
|
|
1140
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1141
|
+
# process the form parameters
|
|
1142
|
+
# process the body parameter
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
# set the HTTP header `Accept`
|
|
1146
|
+
if 'Accept' not in _header_params:
|
|
1147
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1148
|
+
[
|
|
1149
|
+
'application/json'
|
|
1150
|
+
]
|
|
1151
|
+
)
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
# authentication setting
|
|
1155
|
+
_auth_settings: List[str] = [
|
|
1156
|
+
'CookieAuth',
|
|
1157
|
+
'ApiKeyAuth',
|
|
1158
|
+
'OAuth2Auth',
|
|
1159
|
+
'OAuth2Auth',
|
|
1160
|
+
'BearerAuth'
|
|
1161
|
+
]
|
|
1162
|
+
|
|
1163
|
+
return self.api_client.param_serialize(
|
|
1164
|
+
method='POST',
|
|
1165
|
+
resource_path='/v1alpha/reporting/reports/{reportId}',
|
|
1166
|
+
path_params=_path_params,
|
|
1167
|
+
query_params=_query_params,
|
|
1168
|
+
header_params=_header_params,
|
|
1169
|
+
body=_body_params,
|
|
1170
|
+
post_params=_form_params,
|
|
1171
|
+
files=_files,
|
|
1172
|
+
auth_settings=_auth_settings,
|
|
1173
|
+
collection_formats=_collection_formats,
|
|
1174
|
+
_host=_host,
|
|
1175
|
+
_request_auth=_request_auth
|
|
1176
|
+
)
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
@validate_call
|
|
1182
|
+
def get_report(
|
|
1183
|
+
self,
|
|
1184
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")],
|
|
1185
|
+
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,
|
|
1186
|
+
_request_timeout: Union[
|
|
1187
|
+
None,
|
|
1188
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1189
|
+
Tuple[
|
|
1190
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1191
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1192
|
+
]
|
|
1193
|
+
] = None,
|
|
1194
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1195
|
+
_content_type: Optional[StrictStr] = None,
|
|
1196
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1197
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1198
|
+
) -> ReportDTO:
|
|
1199
|
+
"""Retrieve a report's details
|
|
1200
|
+
|
|
1201
|
+
Retrieve the details of a specific report. The response returns information such as title, description, owner, and the allowed actions you can take on the report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
1202
|
+
|
|
1203
|
+
:param report_id: The unique identifier of the report you want to retrieve. (required)
|
|
1204
|
+
:type report_id: str
|
|
1205
|
+
: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.
|
|
1206
|
+
:type target_tenant_id: str
|
|
1207
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1208
|
+
number provided, it will be total request
|
|
1209
|
+
timeout. It can also be a pair (tuple) of
|
|
1210
|
+
(connection, read) timeouts.
|
|
1211
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1212
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1213
|
+
request; this effectively ignores the
|
|
1214
|
+
authentication in the spec for a single request.
|
|
1215
|
+
:type _request_auth: dict, optional
|
|
1216
|
+
:param _content_type: force content-type for the request.
|
|
1217
|
+
:type _content_type: str, Optional
|
|
1218
|
+
:param _headers: set to override the headers for a single
|
|
1219
|
+
request; this effectively ignores the headers
|
|
1220
|
+
in the spec for a single request.
|
|
1221
|
+
:type _headers: dict, optional
|
|
1222
|
+
:param _host_index: set to override the host_index for a single
|
|
1223
|
+
request; this effectively ignores the host_index
|
|
1224
|
+
in the spec for a single request.
|
|
1225
|
+
:type _host_index: int, optional
|
|
1226
|
+
:return: Returns the result object.
|
|
1227
|
+
""" # noqa: E501
|
|
1228
|
+
|
|
1229
|
+
_param = self._get_report_serialize(
|
|
1230
|
+
report_id=report_id,
|
|
1231
|
+
target_tenant_id=target_tenant_id,
|
|
1232
|
+
_request_auth=_request_auth,
|
|
1233
|
+
_content_type=_content_type,
|
|
1234
|
+
_headers=_headers,
|
|
1235
|
+
_host_index=_host_index
|
|
1236
|
+
)
|
|
1237
|
+
|
|
1238
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1239
|
+
'200': "ReportDTO",
|
|
1240
|
+
}
|
|
1241
|
+
response_data = self.api_client.call_api(
|
|
1242
|
+
*_param,
|
|
1243
|
+
_request_timeout=_request_timeout
|
|
1244
|
+
)
|
|
1245
|
+
response_data.read()
|
|
1246
|
+
return self.api_client.response_deserialize(
|
|
1247
|
+
response_data=response_data,
|
|
1248
|
+
response_types_map=_response_types_map,
|
|
1249
|
+
).data
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
@validate_call
|
|
1253
|
+
def get_report_with_http_info(
|
|
1254
|
+
self,
|
|
1255
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")],
|
|
1256
|
+
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,
|
|
1257
|
+
_request_timeout: Union[
|
|
1258
|
+
None,
|
|
1259
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1260
|
+
Tuple[
|
|
1261
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1262
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1263
|
+
]
|
|
1264
|
+
] = None,
|
|
1265
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1266
|
+
_content_type: Optional[StrictStr] = None,
|
|
1267
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1268
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1269
|
+
) -> ApiResponse[ReportDTO]:
|
|
1270
|
+
"""Retrieve a report's details
|
|
1271
|
+
|
|
1272
|
+
Retrieve the details of a specific report. The response returns information such as title, description, owner, and the allowed actions you can take on the report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
1273
|
+
|
|
1274
|
+
:param report_id: The unique identifier of the report you want to retrieve. (required)
|
|
1275
|
+
:type report_id: str
|
|
1276
|
+
: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.
|
|
1277
|
+
:type target_tenant_id: str
|
|
1278
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1279
|
+
number provided, it will be total request
|
|
1280
|
+
timeout. It can also be a pair (tuple) of
|
|
1281
|
+
(connection, read) timeouts.
|
|
1282
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1283
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1284
|
+
request; this effectively ignores the
|
|
1285
|
+
authentication in the spec for a single request.
|
|
1286
|
+
:type _request_auth: dict, optional
|
|
1287
|
+
:param _content_type: force content-type for the request.
|
|
1288
|
+
:type _content_type: str, Optional
|
|
1289
|
+
:param _headers: set to override the headers for a single
|
|
1290
|
+
request; this effectively ignores the headers
|
|
1291
|
+
in the spec for a single request.
|
|
1292
|
+
:type _headers: dict, optional
|
|
1293
|
+
:param _host_index: set to override the host_index for a single
|
|
1294
|
+
request; this effectively ignores the host_index
|
|
1295
|
+
in the spec for a single request.
|
|
1296
|
+
:type _host_index: int, optional
|
|
1297
|
+
:return: Returns the result object.
|
|
1298
|
+
""" # noqa: E501
|
|
1299
|
+
|
|
1300
|
+
_param = self._get_report_serialize(
|
|
1301
|
+
report_id=report_id,
|
|
1302
|
+
target_tenant_id=target_tenant_id,
|
|
1303
|
+
_request_auth=_request_auth,
|
|
1304
|
+
_content_type=_content_type,
|
|
1305
|
+
_headers=_headers,
|
|
1306
|
+
_host_index=_host_index
|
|
1307
|
+
)
|
|
1308
|
+
|
|
1309
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1310
|
+
'200': "ReportDTO",
|
|
1311
|
+
}
|
|
1312
|
+
response_data = self.api_client.call_api(
|
|
1313
|
+
*_param,
|
|
1314
|
+
_request_timeout=_request_timeout
|
|
1315
|
+
)
|
|
1316
|
+
response_data.read()
|
|
1317
|
+
return self.api_client.response_deserialize(
|
|
1318
|
+
response_data=response_data,
|
|
1319
|
+
response_types_map=_response_types_map,
|
|
1320
|
+
)
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
@validate_call
|
|
1324
|
+
def get_report_without_preload_content(
|
|
1325
|
+
self,
|
|
1326
|
+
report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")],
|
|
1327
|
+
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,
|
|
1328
|
+
_request_timeout: Union[
|
|
1329
|
+
None,
|
|
1330
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1331
|
+
Tuple[
|
|
1332
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1333
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1334
|
+
]
|
|
1335
|
+
] = None,
|
|
1336
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1337
|
+
_content_type: Optional[StrictStr] = None,
|
|
1338
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1339
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1340
|
+
) -> RESTResponseType:
|
|
1341
|
+
"""Retrieve a report's details
|
|
1342
|
+
|
|
1343
|
+
Retrieve the details of a specific report. The response returns information such as title, description, owner, and the allowed actions you can take on the report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see `GET /v1alpha/reporting/reports`. <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>
|
|
1344
|
+
|
|
1345
|
+
:param report_id: The unique identifier of the report you want to retrieve. (required)
|
|
1346
|
+
:type report_id: str
|
|
1347
|
+
: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.
|
|
1348
|
+
:type target_tenant_id: str
|
|
1349
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1350
|
+
number provided, it will be total request
|
|
1351
|
+
timeout. It can also be a pair (tuple) of
|
|
1352
|
+
(connection, read) timeouts.
|
|
1353
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1354
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1355
|
+
request; this effectively ignores the
|
|
1356
|
+
authentication in the spec for a single request.
|
|
1357
|
+
:type _request_auth: dict, optional
|
|
1358
|
+
:param _content_type: force content-type for the request.
|
|
1359
|
+
:type _content_type: str, Optional
|
|
1360
|
+
:param _headers: set to override the headers for a single
|
|
1361
|
+
request; this effectively ignores the headers
|
|
1362
|
+
in the spec for a single request.
|
|
1363
|
+
:type _headers: dict, optional
|
|
1364
|
+
:param _host_index: set to override the host_index for a single
|
|
1365
|
+
request; this effectively ignores the host_index
|
|
1366
|
+
in the spec for a single request.
|
|
1367
|
+
:type _host_index: int, optional
|
|
1368
|
+
:return: Returns the result object.
|
|
1369
|
+
""" # noqa: E501
|
|
1370
|
+
|
|
1371
|
+
_param = self._get_report_serialize(
|
|
1372
|
+
report_id=report_id,
|
|
1373
|
+
target_tenant_id=target_tenant_id,
|
|
1374
|
+
_request_auth=_request_auth,
|
|
1375
|
+
_content_type=_content_type,
|
|
1376
|
+
_headers=_headers,
|
|
1377
|
+
_host_index=_host_index
|
|
1378
|
+
)
|
|
1379
|
+
|
|
1380
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1381
|
+
'200': "ReportDTO",
|
|
1382
|
+
}
|
|
1383
|
+
response_data = self.api_client.call_api(
|
|
1384
|
+
*_param,
|
|
1385
|
+
_request_timeout=_request_timeout
|
|
1386
|
+
)
|
|
1387
|
+
return response_data.response
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
def _get_report_serialize(
|
|
1391
|
+
self,
|
|
1392
|
+
report_id,
|
|
1393
|
+
target_tenant_id,
|
|
1394
|
+
_request_auth,
|
|
1395
|
+
_content_type,
|
|
1396
|
+
_headers,
|
|
1397
|
+
_host_index,
|
|
1398
|
+
) -> RequestSerialized:
|
|
1399
|
+
|
|
1400
|
+
_host = None
|
|
1401
|
+
|
|
1402
|
+
_collection_formats: Dict[str, str] = {
|
|
1403
|
+
}
|
|
1404
|
+
|
|
1405
|
+
_path_params: Dict[str, str] = {}
|
|
1406
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1407
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1408
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1409
|
+
_files: Dict[
|
|
1410
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1411
|
+
] = {}
|
|
1412
|
+
_body_params: Optional[bytes] = None
|
|
1413
|
+
|
|
1414
|
+
# process the path parameters
|
|
1415
|
+
if report_id is not None:
|
|
1416
|
+
_path_params['reportId'] = report_id
|
|
1417
|
+
# process the query parameters
|
|
1418
|
+
# process the header parameters
|
|
1419
|
+
if target_tenant_id is not None:
|
|
1420
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1421
|
+
# process the form parameters
|
|
1422
|
+
# process the body parameter
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
# set the HTTP header `Accept`
|
|
1426
|
+
if 'Accept' not in _header_params:
|
|
1427
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1428
|
+
[
|
|
1429
|
+
'application/json'
|
|
1430
|
+
]
|
|
1431
|
+
)
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
# authentication setting
|
|
1435
|
+
_auth_settings: List[str] = [
|
|
1436
|
+
'CookieAuth',
|
|
1437
|
+
'ApiKeyAuth',
|
|
1438
|
+
'OAuth2Auth',
|
|
1439
|
+
'OAuth2Auth',
|
|
1440
|
+
'BearerAuth'
|
|
1441
|
+
]
|
|
1442
|
+
|
|
1443
|
+
return self.api_client.param_serialize(
|
|
1444
|
+
method='GET',
|
|
1445
|
+
resource_path='/v1alpha/reporting/reports/{reportId}',
|
|
1446
|
+
path_params=_path_params,
|
|
1447
|
+
query_params=_query_params,
|
|
1448
|
+
header_params=_header_params,
|
|
1449
|
+
body=_body_params,
|
|
1450
|
+
post_params=_form_params,
|
|
1451
|
+
files=_files,
|
|
1452
|
+
auth_settings=_auth_settings,
|
|
1453
|
+
collection_formats=_collection_formats,
|
|
1454
|
+
_host=_host,
|
|
1455
|
+
_request_auth=_request_auth
|
|
1456
|
+
)
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
@validate_call
|
|
1462
|
+
def get_reports(
|
|
1463
|
+
self,
|
|
1464
|
+
limit: Annotated[Optional[StrictInt], Field(description="Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.")] = None,
|
|
1465
|
+
start: Annotated[Optional[StrictInt], Field(description="Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.")] = None,
|
|
1466
|
+
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,
|
|
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
|
+
) -> ReportListResponseDTO:
|
|
1480
|
+
"""Retrieve a list of reports
|
|
1481
|
+
|
|
1482
|
+
Retrieve a list of reports. The response returns information such as the unique ID, title, description, owner, and the allowed actions you can take on the report. <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 limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.
|
|
1485
|
+
:type limit: int
|
|
1486
|
+
:param start: Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.
|
|
1487
|
+
:type start: int
|
|
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 _request_timeout: timeout setting for this request. If one
|
|
1491
|
+
number provided, it will be total request
|
|
1492
|
+
timeout. It can also be a pair (tuple) of
|
|
1493
|
+
(connection, read) timeouts.
|
|
1494
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1495
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1496
|
+
request; this effectively ignores the
|
|
1497
|
+
authentication in the spec for a single request.
|
|
1498
|
+
:type _request_auth: dict, optional
|
|
1499
|
+
:param _content_type: force content-type for the request.
|
|
1500
|
+
:type _content_type: str, Optional
|
|
1501
|
+
:param _headers: set to override the headers for a single
|
|
1502
|
+
request; this effectively ignores the headers
|
|
1503
|
+
in the spec for a single request.
|
|
1504
|
+
:type _headers: dict, optional
|
|
1505
|
+
:param _host_index: set to override the host_index for a single
|
|
1506
|
+
request; this effectively ignores the host_index
|
|
1507
|
+
in the spec for a single request.
|
|
1508
|
+
:type _host_index: int, optional
|
|
1509
|
+
:return: Returns the result object.
|
|
1510
|
+
""" # noqa: E501
|
|
1511
|
+
|
|
1512
|
+
_param = self._get_reports_serialize(
|
|
1513
|
+
limit=limit,
|
|
1514
|
+
start=start,
|
|
1515
|
+
target_tenant_id=target_tenant_id,
|
|
1516
|
+
_request_auth=_request_auth,
|
|
1517
|
+
_content_type=_content_type,
|
|
1518
|
+
_headers=_headers,
|
|
1519
|
+
_host_index=_host_index
|
|
1520
|
+
)
|
|
1521
|
+
|
|
1522
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1523
|
+
'200': "ReportListResponseDTO",
|
|
1524
|
+
}
|
|
1525
|
+
response_data = self.api_client.call_api(
|
|
1526
|
+
*_param,
|
|
1527
|
+
_request_timeout=_request_timeout
|
|
1528
|
+
)
|
|
1529
|
+
response_data.read()
|
|
1530
|
+
return self.api_client.response_deserialize(
|
|
1531
|
+
response_data=response_data,
|
|
1532
|
+
response_types_map=_response_types_map,
|
|
1533
|
+
).data
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
@validate_call
|
|
1537
|
+
def get_reports_with_http_info(
|
|
1538
|
+
self,
|
|
1539
|
+
limit: Annotated[Optional[StrictInt], Field(description="Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.")] = None,
|
|
1540
|
+
start: Annotated[Optional[StrictInt], Field(description="Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.")] = None,
|
|
1541
|
+
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,
|
|
1542
|
+
_request_timeout: Union[
|
|
1543
|
+
None,
|
|
1544
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1545
|
+
Tuple[
|
|
1546
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1547
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1548
|
+
]
|
|
1549
|
+
] = None,
|
|
1550
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1551
|
+
_content_type: Optional[StrictStr] = None,
|
|
1552
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1553
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1554
|
+
) -> ApiResponse[ReportListResponseDTO]:
|
|
1555
|
+
"""Retrieve a list of reports
|
|
1556
|
+
|
|
1557
|
+
Retrieve a list of reports. The response returns information such as the unique ID, title, description, owner, and the allowed actions you can take on the report. <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>
|
|
1558
|
+
|
|
1559
|
+
:param limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.
|
|
1560
|
+
:type limit: int
|
|
1561
|
+
:param start: Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.
|
|
1562
|
+
:type start: int
|
|
1563
|
+
: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.
|
|
1564
|
+
:type target_tenant_id: str
|
|
1565
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1566
|
+
number provided, it will be total request
|
|
1567
|
+
timeout. It can also be a pair (tuple) of
|
|
1568
|
+
(connection, read) timeouts.
|
|
1569
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1570
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1571
|
+
request; this effectively ignores the
|
|
1572
|
+
authentication in the spec for a single request.
|
|
1573
|
+
:type _request_auth: dict, optional
|
|
1574
|
+
:param _content_type: force content-type for the request.
|
|
1575
|
+
:type _content_type: str, Optional
|
|
1576
|
+
:param _headers: set to override the headers for a single
|
|
1577
|
+
request; this effectively ignores the headers
|
|
1578
|
+
in the spec for a single request.
|
|
1579
|
+
:type _headers: dict, optional
|
|
1580
|
+
:param _host_index: set to override the host_index for a single
|
|
1581
|
+
request; this effectively ignores the host_index
|
|
1582
|
+
in the spec for a single request.
|
|
1583
|
+
:type _host_index: int, optional
|
|
1584
|
+
:return: Returns the result object.
|
|
1585
|
+
""" # noqa: E501
|
|
1586
|
+
|
|
1587
|
+
_param = self._get_reports_serialize(
|
|
1588
|
+
limit=limit,
|
|
1589
|
+
start=start,
|
|
1590
|
+
target_tenant_id=target_tenant_id,
|
|
1591
|
+
_request_auth=_request_auth,
|
|
1592
|
+
_content_type=_content_type,
|
|
1593
|
+
_headers=_headers,
|
|
1594
|
+
_host_index=_host_index
|
|
1595
|
+
)
|
|
1596
|
+
|
|
1597
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1598
|
+
'200': "ReportListResponseDTO",
|
|
1599
|
+
}
|
|
1600
|
+
response_data = self.api_client.call_api(
|
|
1601
|
+
*_param,
|
|
1602
|
+
_request_timeout=_request_timeout
|
|
1603
|
+
)
|
|
1604
|
+
response_data.read()
|
|
1605
|
+
return self.api_client.response_deserialize(
|
|
1606
|
+
response_data=response_data,
|
|
1607
|
+
response_types_map=_response_types_map,
|
|
1608
|
+
)
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
@validate_call
|
|
1612
|
+
def get_reports_without_preload_content(
|
|
1613
|
+
self,
|
|
1614
|
+
limit: Annotated[Optional[StrictInt], Field(description="Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.")] = None,
|
|
1615
|
+
start: Annotated[Optional[StrictInt], Field(description="Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.")] = None,
|
|
1616
|
+
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,
|
|
1617
|
+
_request_timeout: Union[
|
|
1618
|
+
None,
|
|
1619
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1620
|
+
Tuple[
|
|
1621
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1622
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1623
|
+
]
|
|
1624
|
+
] = None,
|
|
1625
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1626
|
+
_content_type: Optional[StrictStr] = None,
|
|
1627
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1628
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1629
|
+
) -> RESTResponseType:
|
|
1630
|
+
"""Retrieve a list of reports
|
|
1631
|
+
|
|
1632
|
+
Retrieve a list of reports. The response returns information such as the unique ID, title, description, owner, and the allowed actions you can take on the report. <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>
|
|
1633
|
+
|
|
1634
|
+
:param limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100.
|
|
1635
|
+
:type limit: int
|
|
1636
|
+
:param start: Optionally, specify the zero-based index of the report to start fetching from. If omitted, the request uses the default value of 0.
|
|
1637
|
+
:type start: int
|
|
1638
|
+
: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.
|
|
1639
|
+
:type target_tenant_id: str
|
|
1640
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1641
|
+
number provided, it will be total request
|
|
1642
|
+
timeout. It can also be a pair (tuple) of
|
|
1643
|
+
(connection, read) timeouts.
|
|
1644
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1645
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1646
|
+
request; this effectively ignores the
|
|
1647
|
+
authentication in the spec for a single request.
|
|
1648
|
+
:type _request_auth: dict, optional
|
|
1649
|
+
:param _content_type: force content-type for the request.
|
|
1650
|
+
:type _content_type: str, Optional
|
|
1651
|
+
:param _headers: set to override the headers for a single
|
|
1652
|
+
request; this effectively ignores the headers
|
|
1653
|
+
in the spec for a single request.
|
|
1654
|
+
:type _headers: dict, optional
|
|
1655
|
+
:param _host_index: set to override the host_index for a single
|
|
1656
|
+
request; this effectively ignores the host_index
|
|
1657
|
+
in the spec for a single request.
|
|
1658
|
+
:type _host_index: int, optional
|
|
1659
|
+
:return: Returns the result object.
|
|
1660
|
+
""" # noqa: E501
|
|
1661
|
+
|
|
1662
|
+
_param = self._get_reports_serialize(
|
|
1663
|
+
limit=limit,
|
|
1664
|
+
start=start,
|
|
1665
|
+
target_tenant_id=target_tenant_id,
|
|
1666
|
+
_request_auth=_request_auth,
|
|
1667
|
+
_content_type=_content_type,
|
|
1668
|
+
_headers=_headers,
|
|
1669
|
+
_host_index=_host_index
|
|
1670
|
+
)
|
|
1671
|
+
|
|
1672
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1673
|
+
'200': "ReportListResponseDTO",
|
|
1674
|
+
}
|
|
1675
|
+
response_data = self.api_client.call_api(
|
|
1676
|
+
*_param,
|
|
1677
|
+
_request_timeout=_request_timeout
|
|
1678
|
+
)
|
|
1679
|
+
return response_data.response
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
def _get_reports_serialize(
|
|
1683
|
+
self,
|
|
1684
|
+
limit,
|
|
1685
|
+
start,
|
|
1686
|
+
target_tenant_id,
|
|
1687
|
+
_request_auth,
|
|
1688
|
+
_content_type,
|
|
1689
|
+
_headers,
|
|
1690
|
+
_host_index,
|
|
1691
|
+
) -> RequestSerialized:
|
|
1692
|
+
|
|
1693
|
+
_host = None
|
|
1694
|
+
|
|
1695
|
+
_collection_formats: Dict[str, str] = {
|
|
1696
|
+
}
|
|
1697
|
+
|
|
1698
|
+
_path_params: Dict[str, str] = {}
|
|
1699
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1700
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1701
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1702
|
+
_files: Dict[
|
|
1703
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1704
|
+
] = {}
|
|
1705
|
+
_body_params: Optional[bytes] = None
|
|
1706
|
+
|
|
1707
|
+
# process the path parameters
|
|
1708
|
+
# process the query parameters
|
|
1709
|
+
if limit is not None:
|
|
1710
|
+
|
|
1711
|
+
_query_params.append(('limit', limit))
|
|
1712
|
+
|
|
1713
|
+
if start is not None:
|
|
1714
|
+
|
|
1715
|
+
_query_params.append(('start', start))
|
|
1716
|
+
|
|
1717
|
+
# process the header parameters
|
|
1718
|
+
if target_tenant_id is not None:
|
|
1719
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1720
|
+
# process the form parameters
|
|
1721
|
+
# process the body parameter
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
# set the HTTP header `Accept`
|
|
1725
|
+
if 'Accept' not in _header_params:
|
|
1726
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1727
|
+
[
|
|
1728
|
+
'application/json'
|
|
1729
|
+
]
|
|
1730
|
+
)
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
# authentication setting
|
|
1734
|
+
_auth_settings: List[str] = [
|
|
1735
|
+
'CookieAuth',
|
|
1736
|
+
'ApiKeyAuth',
|
|
1737
|
+
'OAuth2Auth',
|
|
1738
|
+
'OAuth2Auth',
|
|
1739
|
+
'BearerAuth'
|
|
1740
|
+
]
|
|
1741
|
+
|
|
1742
|
+
return self.api_client.param_serialize(
|
|
1743
|
+
method='GET',
|
|
1744
|
+
resource_path='/v1alpha/reporting/reports',
|
|
1745
|
+
path_params=_path_params,
|
|
1746
|
+
query_params=_query_params,
|
|
1747
|
+
header_params=_header_params,
|
|
1748
|
+
body=_body_params,
|
|
1749
|
+
post_params=_form_params,
|
|
1750
|
+
files=_files,
|
|
1751
|
+
auth_settings=_auth_settings,
|
|
1752
|
+
collection_formats=_collection_formats,
|
|
1753
|
+
_host=_host,
|
|
1754
|
+
_request_auth=_request_auth
|
|
1755
|
+
)
|
|
1756
|
+
|
|
1757
|
+
|